[plt-scheme] contracts in scribble @defproc: must they actually be in the code, too?

From: Matthew Flatt (mflatt at cs.utah.edu)
Date: Fri Feb 15 17:16:09 EST 2008

At Fri, 15 Feb 2008 14:13:56 -0800, John Clements wrote:
> Suppose I'm documenting a function that accepts a procedure that's  
> supposed to return a string, but the documented function doesn't  
> actually have a contract that checks this.  Should the contract  
> specified in the scribble documentation then include the contract (->  
> string?) or the contract (-> any) for this argument?

(-> string?)

In general, document the contract that should be there.

Matthew



Posted on the users mailing list.