[plt-scheme] Function documentation strategy?

From: Noel Welsh (noelwelsh at gmail.com)
Date: Thu May 10 12:41:03 EDT 2007

On 5/10/07, Grant Rettke <grettke at acm.org> wrote:

> Is there a standard approach for documenting in this style?

More-or-less just write down the contract (as in (lib "contract.ss"))
using infix notation


foo bar -> baz

instead of

(-> foo bar baz)

Bonus points if you write

(foo bar . -> . baz)

Square brackets indicate optional arguments. E.g.

foo bar [quux] -> baz


Posted on the users mailing list.