[racket-dev] Strange problem with `check-docs' and `#:use-sources'

From: Robby Findler (robby at eecs.northwestern.edu)
Date: Wed Jun 22 18:53:36 EDT 2011

To really know what is going on, one has to trace thru the re-provides
for each of these identifiers and match them up to the
declare-exporting declarations.

In the declaration below, you're essentially saying "any identifiers
documented in this module should appear to come from the
typed/scheme/base, typed/scheme, and typed-scheme modules, but they
are really actually exported from one of the modules listed in the
#:use-sources keyword" which means, to the documentation system that
any module that re-exports an identifier from, say,
typed-scheme/base-env/base-types-extra, will have its documentation
attached to the docs in the file with the declare-exporting below and
the docs system will then point userse to typed/scheme/base.

I don't think that this is what you want, since you probably want to
to point people to typed/racket.

To know what the right answer is for the declare-exporting below, I'd
have to know how typed/racket fits into the picture. In particular, is
it re-exporting things from typed/scheme? Or from those helper modules
you have listed? Or from some other place?


On Thu, Jun 23, 2011 at 3:16 AM, Sam Tobin-Hochstadt <samth at ccs.neu.edu> wrote:
> Currently, the documentation completeness checker (a wonderful tool;
> thanks, Robby!) for Typed Racket complains that `->' and
> `with-handlers' are not documented when provided from `typed/scheme',
> `typed/scheme/base', and `typed-scheme'.  However, these identifiers
> are fine when provided from `typed/racket', and are both defined in
> modules where `check-docs' finds the documentation for other things
> just fine, such as `define:' and `All'.  The documentation looks like
> this:
> (declare-exporting typed/scheme/base typed/scheme typed-scheme
>                    #:use-sources
>                    (typed-scheme/typed-scheme
>                     typed-scheme/base-env/prims
>                     typed-scheme/base-env/extra-procs
>                     typed-scheme/base-env/base-types
>                     typed-scheme/base-env/base-types-extra))
> where `->' is defined in `typed-scheme/base-env/base-types-extra' and
> `with-handlers' is defined in `typed-scheme/base-env/prims'.
> Is there something else I should be doing here?  Is there a bug in
> `check-docs'?
> --
> sam th
> samth at ccs.neu.edu
> _________________________________________________
>  For list-related administrative tasks:
>  http://lists.racket-lang.org/listinfo/dev

Posted on the dev mailing list.