suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarified the purpose of quote-module-name and quote-module-path in the Scribble docs.

Browse Source
This commit is contained in:
Carl Eastlund 2013-01-14 16:08:44 -05:00
parent 230172cf94
commit b03450c7b0
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
collects/syntax/scribblings/srcloc.scrbl
View File

@ -296,9 +296,13 @@ the whole macro application if no @racket[form] is given.
@defform[(quote-module-name submod-path-element ...)]{
Quotes the name of the module in which the form is compiled as a path,
symbol, list, or @racket['top-level], where @racket['top-level] is
produced when used outside of a module. A list corresponds to a
Quotes the name of the module in a form suitable for printing, but not
necessarily as a valid @tech[#:doc reference-path]{module path}. See
@racket[quote-module-path] for constructing quoted
@tech[#:doc reference-path]{module path}s.
Returns a path, symbol, list, or @racket['top-level], where @racket['top-level]
is produced when used outside of a module. A list corresponds to a
submodule in the same format as the result of
@racket[variable-reference->module-name]. Any given
@racket[submod-path-element]s (as in a @racket[submod] form) are added
@ -339,10 +343,13 @@ b-name
@defform[(quote-module-path submod-path-element ...)]{
Quotes the name of the module in which the form is compiled as a
@tech[#:doc reference-path]{module path} using @racket[quote], a path,
@racket[submod], or @racket['top-level], where @racket['top-level] is
produced when used outside of a module. Any given
Quotes the name of the module in which the form is compiled. When possible,
the result is a valid @tech[#:doc reference-path]{module path} suitable for use
by @racket[dynamic-require] and similar functions.
Builds the result using
@racket[quote], a path, @racket[submod], or @racket['top-level], where
@racket['top-level] is produced when used outside of a module. Any given
@racket[submod-path-element]s (as in a @racket[submod] form) are added
to form a result submodule path.