doc clarification

original commit: 4945851df67386945bd1049e1b276b3459354a8c
This commit is contained in:
Matthew Flatt 2010-08-17 17:42:11 -06:00
parent d6bbf9dfe5
commit 6a51476ecd

View File

@ -233,12 +233,13 @@ beginning of each line.
The @racket[str]s are @emph{not} decoded with @racket[decode-content], The @racket[str]s are @emph{not} decoded with @racket[decode-content],
so @racket[(verbatim "---")] renders with three hyphens instead of an so @racket[(verbatim "---")] renders with three hyphens instead of an
em-dash. Beware, however, that @litchar["@"] for a @racket[verbatim] em-dash. Beware, however, that @emph{reading}
call performs some processing before delivering arguments to @litchar["@"]@racket[verbatim] converts @litchar["@"] syntax
@racket[verbatim]. The @racket[verbatim] form is typically used with within the argument, and such reading occurs well before
@litchar["|{"]...@litchar["}|"] or similar brackets to disable arguments to @racket[verbatim] are delivered at run-time. To disable simple
@litchar["@"] notation within the @racket[verbatim] argument, like @litchar["@"] notation within the @racket[verbatim] argument,
this: @racket[verbatim] is typically used with
@litchar["|{"]...@litchar["}|"] or similar brackets, like this:
@verbatim[#:indent 2]|{ @verbatim[#:indent 2]|{
@verbatim|{ @verbatim|{
@ -253,8 +254,8 @@ which renders as
}| }|
Even with @litchar["|{"]...@litchar["}|"], beware that consistent Even with @litchar["|{"]...@litchar["}|"], beware that consistent
leading whitespace is removed; see @secref["alt-body-syntax"] for more leading whitespace is removed by the parser; see
information. @secref["alt-body-syntax"] for more information.
See also @racket[literal].} See also @racket[literal].}