Improve docs for sub-in.

This commit is contained in:
Vincent St-Amour 2011-05-24 14:42:06 -04:00
parent 7615c2a512
commit 2cddccfe7e

View File

@ -1161,10 +1161,20 @@ but then sub-directories that are called
@filepath{utils} override the one in the project's root.
In other words, the previous method requires only a single unique name.}
@defform[(sub-in parent child ...)]{
@defform[(sub-in parent child ...)
#:contracts ([parent module-path?] [child module-path?])]{
Specifies multiple files to be required from directory
@racket[parent] relative to the current directory, or from
subcollects @racket[child] in collect @racket[parent].
For example:
@racketblock[(require (sub-in racket list dict))]
is equivalent to:
@racketblock[(require racket/list racket/dict)]
Similarly:
@racketblock[(require (sub-in "utils" "math.rkt" "matrix.rkt"))]
is equivalent to:
@racketblock[(require "utils/math.rkt" "utils/matrix.rkt")]
}
@; --------------------