From b03450c7b0dbb0e6d31a5ffcbd0a62de385bb814 Mon Sep 17 00:00:00 2001 From: Carl Eastlund Date: Mon, 14 Jan 2013 16:08:44 -0500 Subject: [PATCH] Clarified the purpose of quote-module-name and quote-module-path in the Scribble docs. --- collects/syntax/scribblings/srcloc.scrbl | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/collects/syntax/scribblings/srcloc.scrbl b/collects/syntax/scribblings/srcloc.scrbl index 745fe0c637..4d27abab77 100644 --- a/collects/syntax/scribblings/srcloc.scrbl +++ b/collects/syntax/scribblings/srcloc.scrbl @@ -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.