[plt-scheme] Scribble change

From: Matthew Flatt (mflatt at cs.utah.edu)
Date: Thu Jan 3 14:10:45 EST 2008

The latest Scribble, v3.99.0.9 in SVN, changes the way that lexical
binding is used to determine documentation links.

Identifiers are still linked based on `for-label' bindings in the
document source. However, the link is now based on the "nominal" source
of an imported binding, instead of the definition site. For example,

   (require (for-label (only-in mzscheme car)))

and

   (require (for-label (only-in scheme/base car)))

both import the same `car' binding (in the sense of `free-identifier=?'),
but the different ways of getting that binding can lead to different
documentation. Only the second way is currently documented, but I'll
soon start working on "legacy" docs.

On the definition side, you must use `defmodule' or `declare-exporting'
to declare the module for which `defproc', `defform', etc. will
document names. You need to use something like `defmodule', anyway, for
readers to know what module you're documenting.

Matthew



Posted on the users mailing list.