fix uses of `scheme' in the Scribble style guide
Closes PR 10999
Merge to 5.0.1
(cherry picked from commit 4bd97ae80e
)
This commit is contained in:
parent
22c8680dc9
commit
2c75fe25a9
|
@ -8,7 +8,7 @@
|
|||
|
||||
@section{Prose and Terminology}
|
||||
|
||||
In the descriptive body of @scheme[defform], @scheme[defproc], etc.,
|
||||
In the descriptive body of @racket[defform], @racket[defproc], etc.,
|
||||
do not start with ``This ...'' Instead, start with a sentence whose
|
||||
implicit subject is the form or value being described. Capitalize the
|
||||
first word. Thus, the description will often start with ``Returns'' or
|
||||
|
@ -18,7 +18,7 @@ Do not use the word ``argument'' to describe a sub-form in a syntactic
|
|||
form; use the term ``sub-form'' instead, reserving ``argument'' for
|
||||
values or expressions in a function call. Refer to libraries and
|
||||
languages as such, rather than as ``modules'' (even though the form to
|
||||
typeset a library or language name is called @scheme[schememodname]).
|
||||
typeset a library or language name is called @racket[racketmodname]).
|
||||
Do not call an identifier (i.e., a syntactic element) a ``variable''
|
||||
or a ``symbol.'' Do not use the word ``expression'' for a form that is
|
||||
a definition or might be a definition; use the word ``form,'' instead.
|
||||
|
@ -26,59 +26,59 @@ Prefer ``function'' to ``procedure.''
|
|||
|
||||
Avoid cut-and-paste for descriptive text. If two functions are
|
||||
similar, consider documenting them together with
|
||||
@scheme[deftogether]. To abstract a description, consider using
|
||||
explicit prose abstraction, such as ``@scheme[x] is like @scheme[y],
|
||||
@racket[deftogether]. To abstract a description, consider using
|
||||
explicit prose abstraction, such as ``@racket[x] is like @racket[y],
|
||||
except that ...,'' instead of abstracting the source and instantiating
|
||||
it multiple times; often, a prose abstraction is clearer to the reader
|
||||
than a hidden abstraction in the document implementation.
|
||||
|
||||
@section{Typesetting Code}
|
||||
|
||||
Use @schemeidfont{id} or a name that ends @schemeidfont{-id} in
|
||||
@scheme[defform] to mean an identifier, not @schemeidfont{identifier},
|
||||
@schemeidfont{variable}, @schemeidfont{name}, or
|
||||
@schemeidfont{symbol}. Similarly, use @schemeidfont{expr} or something
|
||||
that ends @schemeidfont{-expr} for an expression position within a
|
||||
syntactic form. Use @schemeidfont{body} for a form (definition or
|
||||
Use @racketidfont{id} or a name that ends @racketidfont{-id} in
|
||||
@racket[defform] to mean an identifier, not @racketidfont{identifier},
|
||||
@racketidfont{variable}, @racketidfont{name}, or
|
||||
@racketidfont{symbol}. Similarly, use @racketidfont{expr} or something
|
||||
that ends @racketidfont{-expr} for an expression position within a
|
||||
syntactic form. Use @racketidfont{body} for a form (definition or
|
||||
expression) in an internal-definition position. Do not use
|
||||
@schemeidfont{expr} for something that isn't exactly an expression,
|
||||
@scheme[id] for something that isn't exactly an identifier, etc.;
|
||||
instead, use @scheme[defform/subs] to define a new non-terminal.
|
||||
@racketidfont{expr} for something that isn't exactly an expression,
|
||||
@racket[id] for something that isn't exactly an identifier, etc.;
|
||||
instead, use @racket[defform/subs] to define a new non-terminal.
|
||||
|
||||
Beware of using @scheme[deftogether] to define multiple variants of a
|
||||
syntactic form or procedure, because each @scheme[defform] or
|
||||
@scheme[defproc] creates a definition point, but each form or
|
||||
Beware of using @racket[deftogether] to define multiple variants of a
|
||||
syntactic form or procedure, because each @racket[defform] or
|
||||
@racket[defproc] creates a definition point, but each form or
|
||||
procedure should have a single definition point. (Scribble issues a
|
||||
warning when a binding has multiple definition points.) Instead, use
|
||||
@scheme[defproc*] or @scheme[defform*].
|
||||
@racket[defproc*] or @racket[defform*].
|
||||
|
||||
Pay attention to the difference between identifiers and meta-variables
|
||||
when using @scheme[scheme], especially outside of @scheme[defproc] or
|
||||
@scheme[defform]. Prefix a meta-variable with @litchar{_}; for
|
||||
when using @racket[racket], especially outside of @racket[defproc] or
|
||||
@racket[defform]. Prefix a meta-variable with @litchar{_}; for
|
||||
example,
|
||||
|
||||
@verbatim[#:indent 2]|{@scheme[(rator-expr rand-expr ...)]}|
|
||||
@verbatim[#:indent 2]|{@racket[(rator-expr rand-expr ...)]}|
|
||||
|
||||
would be the wrong way to refer to the grammar of a function call,
|
||||
because it produces @scheme[(rator-expr rand-expr ...)], where
|
||||
@schemeidfont{rator-expr} and @schemeidfont{rand-expr} are
|
||||
because it produces @racket[(rator-expr rand-expr ...)], where
|
||||
@racketidfont{rator-expr} and @racketidfont{rand-expr} are
|
||||
typeset as variables. The correct description is
|
||||
|
||||
@verbatim[#:indent 2]|{@scheme[(_rator-expr _rand-expr ...)]}|
|
||||
@verbatim[#:indent 2]|{@racket[(_rator-expr _rand-expr ...)]}|
|
||||
|
||||
which produces @scheme[(_rator-expr _rand-expr ...)], where
|
||||
@schemeidfont{rator-expr} and @schemeidfont{rand-expr} are typeset as
|
||||
meta-variables. The @scheme[defproc], @scheme[defform], @|etc| forms
|
||||
which produces @racket[(_rator-expr _rand-expr ...)], where
|
||||
@racketidfont{rator-expr} and @racketidfont{rand-expr} are typeset as
|
||||
meta-variables. The @racket[defproc], @racket[defform], @|etc| forms
|
||||
greatly reduce this burden in descriptions, since they automatically
|
||||
set up meta-variable typesetting for non-literal identifiers. In
|
||||
@scheme[defform], be sure to include literal identifiers (i.e., those
|
||||
@racket[defform], be sure to include literal identifiers (i.e., those
|
||||
not meant as variables, other than the form name being defined) in a
|
||||
@scheme[#:literals] clause.
|
||||
@racket[#:literals] clause.
|
||||
|
||||
To typeset an identifier with no particular interpretation---syntax,
|
||||
variable, meta-variable, etc.---use @scheme[schemeidfont] (e.g., as in
|
||||
@schemeidfont{rand-expr} above). Otherwise, use @scheme[litchar],
|
||||
not merely @scheme[schemefont] or @scheme[verbatim], to refer to a
|
||||
variable, meta-variable, etc.---use @racket[racketidfont] (e.g., as in
|
||||
@racketidfont{rand-expr} above). Otherwise, use @racket[litchar],
|
||||
not merely @racket[racketfont] or @racket[verbatim], to refer to a
|
||||
specific sequence of characters.
|
||||
|
||||
When showing example evaluations, use the REPL-snapshot style:
|
||||
|
@ -89,7 +89,7 @@ When showing example evaluations, use the REPL-snapshot style:
|
|||
]
|
||||
}|
|
||||
|
||||
See also the @scheme[scribble/eval] library.
|
||||
See also the @racket[scribble/eval] library.
|
||||
|
||||
Use four dots, @litchar{....}, in place of omitted code, since
|
||||
@litchar{...} means repetition.
|
||||
|
@ -112,12 +112,12 @@ at the end of quotation marks (i.e., a sentence-terminating period
|
|||
goes inside the quotation marks). Of course, this rule does not apply
|
||||
for quotation marks that are part of code.
|
||||
|
||||
Do not use a citation reference (as created by @scheme[cite]) as a
|
||||
Do not use a citation reference (as created by @racket[cite]) as a
|
||||
noun; use it as an annotation.
|
||||
|
||||
Do not start a sentence with a Scheme variable name, since it is
|
||||
normally lowercase. For example, use ``The @scheme[_thing] argument
|
||||
is...'' instead of ``@scheme[_thing] is...''
|
||||
Do not start a sentence with a Racket variable name, since it is
|
||||
normally lowercase. For example, use ``The @racket[_thing] argument
|
||||
is...'' instead of ``@racket[_thing] is...''
|
||||
|
||||
@section{Section Titles}
|
||||
|
||||
|
@ -126,7 +126,7 @@ prepositions, and conjunctions that are not at the start of the title.
|
|||
|
||||
A manual title should normally start with a suitable keyword or key
|
||||
phrase (such as ``Scribble'' for this manual) that is in boldface. If
|
||||
the key word is primarily an executable name, use @scheme[exec]
|
||||
instead of @scheme[bold]. Optionally add further descriptive text in
|
||||
the key word is primarily an executable name, use @racket[exec]
|
||||
instead of @racket[bold]. Optionally add further descriptive text in
|
||||
the title after a colon, where the text starting with the colon is not
|
||||
in boldface.
|
||||
|
|
Loading…
Reference in New Issue
Block a user