[racket] How to read procedure documentation?

From: Manfred Lotz (manfred.lotz at arcor.de)
Date: Fri Apr 19 16:02:04 EDT 2013

On Fri, 19 Apr 2013 15:00:29 -0400
Neil Van Dyke <neil at neilvandyke.org> wrote:

> Manfred Lotz wrote at 04/19/2013 02:18 PM:
> >  From this I'm wondering why there are predicates when for example I
> > would expect strings?
> >    
> 
> The language you're seeing is mostly that of Racket *contracts*, even 
> though the implementation might not be using the Racket contract 
> software mechanism: 
> http://docs.racket-lang.org/guide/contract-boundaries.html
> 

Yeah, I just started to read about contracts.

> It is not the prettiest or fastest way to communicate a synopsis for
> a bit of API, but you can quickly learn how to read it slowly.
> 

But it is more powerful. Saying that path must satisfy path-string?
pretty accurate.

At least this is my immediate impression after understanding how to
read the synopsis.


-- 
Manfred


Posted on the users mailing list.