[plt-dev] [PATCH] Various typo, spelling, and punctuation fixes in scribblings.
Reviewed and applied with one fix.
Jay
On Fri, May 28, 2010 at 2:37 PM, David Van Horn <dvanhorn at ccs.neu.edu> wrote:
>
> Signed-off-by: David Van Horn <dvanhorn at ccs.neu.edu>
> ---
> .../drracket/interface-essentials.scrbl | 14 +++++++-------
> collects/scribblings/foreign/libs.scrbl | 3 ++-
> collects/scribblings/foreign/types.scrbl | 18 +++++++++---------
> collects/scribblings/gui/canvas-class.scrbl | 4 ++--
> collects/scribblings/gui/style-delta-class.scrbl | 4 ++--
> collects/scribblings/guide/class.scrbl | 2 +-
> collects/scribblings/guide/define-struct.scrbl | 10 +++++-----
> collects/scribblings/guide/vectors.scrbl | 2 +-
> collects/scribblings/inside/custodians.scrbl | 2 +-
> collects/scribblings/inside/eval.scrbl | 4 ++--
> collects/scribblings/inside/exns.scrbl | 4 ++--
> collects/scribblings/inside/memory.scrbl | 8 ++++----
> collects/scribblings/inside/misc.scrbl | 2 +-
> collects/scribblings/inside/values.scrbl | 2 +-
> collects/scribblings/reference/stx-comp.scrbl | 2 +-
> 15 files changed, 41 insertions(+), 40 deletions(-)
>
> diff --git a/collects/scribblings/drracket/interface-essentials.scrbl b/collects/scribblings/drracket/interface-essentials.scrbl
> index 3631651..1c6872e 100644
> --- a/collects/scribblings/drracket/interface-essentials.scrbl
> +++ b/collects/scribblings/drracket/interface-essentials.scrbl
> @@ -58,7 +58,7 @@ pathname. Selecting one of the menu entries produces an open-file
> dialog starting in the corresponding directory.
>
> Below the filename button is a @as-index{@onscreen{(define ...)}
> -button} for a popup menu of names that are defined in the definitions
> +button} for a pop-up menu of names that are defined in the definitions
> window. Selecting an item from the menu moves the blinking caret to
> the corresponding definition.
>
> @@ -119,8 +119,8 @@ annotations:
>
> @index['("alpha renaming")]{Additionally}, right-clicking (or
> Control-clicking under Mac OS X) on a variable activates a
> - popup menu that lets you jump from binding location to bound
> - location and vice-versa, @as-index{@"\u03B1"-rename} the
> + pop-up menu that lets you jump from binding location to bound
> + location and vice versa, @as-index{@"\u03B1"-rename} the
> variable, or tack the arrows so they do not disappear.}
>
> @item{@index['("tail calls")]{@bold{Tail Calls:}} Any
> @@ -131,7 +131,7 @@ annotations:
>
> @item{@bold{Require Annotations:} Right-clicking (or
> Control-clicking under Mac OS X) on the argument to
> - @racket[require] activates a popup menu that lets you open the
> + @racket[require] activates a pop-up menu that lets you open the
> file that contains the @racket[require]d module.
>
> Passing the mouse cursor over a @racket[require] expression
> @@ -219,7 +219,7 @@ Tab.
> @index['("changing a parenthesis as you type")]{@index['("automatic
> parenthesis")]{DrRacket}} also rewrites parenthesis as you type them,
> in order to make them match better. If you type a closing parenthesis
> - at litchar{)}, a closing square bracket @litchar{]}, or a closing curley brace
> + at litchar{)}, a closing square bracket @litchar{]}, or a closing curly brace
> @litchar["}"], and if DrRacket can match it back to some earlier opening
> parenthesis, bracket, or brace, then DrRacket changes what you type to
> match. DrRacket also rewrites open square brackets, usually to an
> @@ -300,7 +300,7 @@ DrRacket also supports a mode where typing in the search
> editor takes you directly to the next occurrence of the
> search string, without selecting the @onscreen{Find Again}
> menu item. In the preference dialog, in the
> - at onscreen{Editing} sectino and then in the
> + at onscreen{Editing} section and then in the
> @onscreen{General} section is a checkbox labelled
> @onscreen{Search using anchors}. When it is checked,
> DrRacket shows a little red dot and a red line indicating
> @@ -731,7 +731,7 @@ A module browser window contains a square for each
>
> The module browser will also show you the phases that each
> module is loaded in; choose the ``Long, with phases'' menu item
> - in the ``Names'' popup menu. The integers indicate the phases and
> + in the ``Names'' pop-up menu. The integers indicate the phases and
> if @racket[#f] is present, it means the module is loaded @racket[for-label].
>
> @section[#:tag "create-exe"]{Creating Executables}
> diff --git a/collects/scribblings/foreign/libs.scrbl b/collects/scribblings/foreign/libs.scrbl
> index e8248e4..95824d6 100644
> --- a/collects/scribblings/foreign/libs.scrbl
> +++ b/collects/scribblings/foreign/libs.scrbl
> @@ -1,5 +1,6 @@
> #lang scribble/doc
> @(require "utils.ss"
> + (for-label setup/dirs)
> (for-syntax setup/dirs))
>
> @title{Loading Foreign Libraries}
> @@ -42,7 +43,7 @@ particular, use @scheme[#f] to access C-level functionality exported
> by the run-time system (as described in @|InsideRacket|).
>
> Note: @scheme[ffi-lib] tries to look for the library file in a few
> -places, inluding the PLT libraries (see @scheme[get-lib-search-dirs]),
> +places, including the PLT libraries (see @scheme[get-lib-search-dirs]),
> a relative path, or a system search. When @scheme[version] is a list,
> different versions are tried through each route before continuing the
> search with other routes. However, if @cpp{dlopen} cannot open a
> diff --git a/collects/scribblings/foreign/types.scrbl b/collects/scribblings/foreign/types.scrbl
> index 41ec516..6218496 100644
> --- a/collects/scribblings/foreign/types.scrbl
> +++ b/collects/scribblings/foreign/types.scrbl
> @@ -169,7 +169,7 @@ pointer.
>
> A type for Racket's native Unicode strings, which are in UCS-4 format.
> These correspond to the C @cpp{mzchar*} type used by Racket. As usual, the types
> -treat @scheme[#f] as @cpp{NULL} and vice-versa.}
> +treat @scheme[#f] as @cpp{NULL} and vice versa.}
>
>
> @deftogether[(
> @@ -177,13 +177,13 @@ treat @scheme[#f] as @cpp{NULL} and vice-versa.}
> )]{
>
> Unicode strings in UTF-16 format. As usual, the types treat
> - at scheme[#f] as @cpp{NULL} and vice-versa.}
> + at scheme[#f] as @cpp{NULL} and vice versa.}
>
>
> @defthing[_path ctype?]{
>
> Simple @cpp{char*} strings, corresponding to Racket's paths. As usual,
> -the types treat @scheme[#f] as @cpp{NULL} and vice-versa.
> +the types treat @scheme[#f] as @cpp{NULL} and vice versa.
>
> Beware that changing the current directory via
> @scheme[current-directory] does not change the OS-level current
> @@ -208,7 +208,7 @@ Return values using this type are interned as symbols.}
> Types that correspond to (character) strings on the Racket side and
> @cpp{char*} strings on the C side. The bridge between the two requires
> a transformation on the content of the string. As usual, the types
> -treat @scheme[#f] as @cpp{NULL} and vice-versa.}
> +treat @scheme[#f] as @cpp{NULL} and vice versa.}
>
> @defthing*[([_string*/utf-8 ctype?]
> [_string*/latin-1 ctype?]
> @@ -272,7 +272,7 @@ an arbitrary Racket object attached as a type tag. The tag is ignored
> by built-in functionality; it is intended to be used by interfaces.
> See @secref["foreign:tagged-pointers"] for creating pointer types that
> use these tags for safety. A @scheme[#f] value is converted to
> - at cpp{NULL} and vice-versa.
> + at cpp{NULL} and vice versa.
>
> The address referenced by a @scheme[_pointer] value must not refer to
> memory managed by the garbage collector (unless the address
> @@ -313,7 +313,7 @@ is extracted from a pointer produced by @scheme[ffi-obj-ref], then a
> level of indirection is skipped. A level of indirection is similarly
> skipped when extracting a pointer via @scheme[get-ffi-obj]. Like
> @scheme[_pointer], @scheme[_fpointer] treats @scheme[#f] as @cpp{NULL}
> -and vice-versa.
> +and vice versa.
>
> A type generated by @scheme[_cprocedure] builds on @scheme[_fpointer],
> and normally @scheme[_cprocedure] should be used instead of
> @@ -323,7 +323,7 @@ and normally @scheme[_cprocedure] should be used instead of
> @defproc[(_or-null [ctype ctype?]) ctype?]{
>
> Creates a type that is like @scheme[ctype], but @scheme[#f] is
> -converted to @cpp{NULL} and vice-versa. The given @scheme[ctype] must
> +converted to @cpp{NULL} and vice versa. The given @scheme[ctype] must
> have the same C representation as @scheme[_pointer],
> @scheme[_gcpointer], or @scheme[_fpointer].}
>
> @@ -362,7 +362,7 @@ The resulting type can be used to reference foreign functions (usually
> generating a matching foreign callout object. Such objects are new primitive
> procedure objects that can be used like any other Racket procedure.
> As with other pointer types, @scheme[#f] is treated as a @cpp{NULL}
> -function pointer and vice-versa.
> +function pointer and vice versa.
>
> A type created with @scheme[_cprocedure] can also be used for passing
> Racket procedures to foreign functions, which will generate a foreign
> @@ -925,7 +925,7 @@ Constructing a @cpp{B} instance in Racket requires allocating a
>
> To make this more efficient, we switch to the alternative
> @scheme[define-cstruct] syntax, which creates a constructor that
> -expects arguments for both the super fields ands the new ones:
> +expects arguments for both the super fields and the new ones:
>
> @schemeblock[
> (define-cstruct (#,(schemeidfont "_B") #,(schemeidfont "_A")) ([z _int]))
> diff --git a/collects/scribblings/gui/canvas-class.scrbl b/collects/scribblings/gui/canvas-class.scrbl
> index 0550c2e..16ee2c7 100644
> --- a/collects/scribblings/gui/canvas-class.scrbl
> +++ b/collects/scribblings/gui/canvas-class.scrbl
> @@ -184,7 +184,7 @@ See also
> @method[canvas% init-manual-scrollbars] for information about manual scrollbars. The horizontal and vertical
> scrollbars are always either both manual or both automatic, but they
> are independently enabled. Automatic scrollbars can be
> - re-initialized as manual, and vice-versa.
> + re-initialized as manual, and vice versa.
>
> If either @scheme[horiz-pixels] or @scheme[vert-pixels] is
> @scheme[#f], the scrollbar is not enabled in the corresponding
> @@ -224,7 +224,7 @@ See also
> @method[canvas% init-auto-scrollbars] for information about automatic scrollbars. The horizontal and vertical
> scrollbars are always either both manual or both automatic, but they
> are independently enabled. Automatic scrollbars can be re-initialized
> - as manual, and vice-versa.
> + as manual, and vice versa.
>
> The @scheme[h-length] and @scheme[v-length] arguments specify the length of
> each scrollbar in scroll steps (i.e., the maximum value of each
> diff --git a/collects/scribblings/gui/style-delta-class.scrbl b/collects/scribblings/gui/style-delta-class.scrbl
> index e75d0b3..c68afd0 100644
> --- a/collects/scribblings/gui/style-delta-class.scrbl
> +++ b/collects/scribblings/gui/style-delta-class.scrbl
> @@ -404,8 +404,8 @@ the possible values are:
> @itemize[
> @item{@scheme['change-nothing] --- reset all changes}
> @item{@scheme['change-normal] --- turn off all styles and resizings}
> - at item{@scheme['change-toggle-underline] --- underline regions that are currently not underlined, and vice-versa}
> - at item{@scheme['change-toggle-size-in-pixels] --- interpret sizes in pixels for regions that are currently interpreted in points, and vice-versa}
> + at item{@scheme['change-toggle-underline] --- underline regions that are currently not underlined, and vice versa}
> + at item{@scheme['change-toggle-size-in-pixels] --- interpret sizes in pixels for regions that are currently interpreted in points, and vice versa}
> @item{@scheme['change-normal-color] --- change the foreground and background to black and white, respectively}
> @item{@scheme['change-italic] --- change the style of the font to @italic{italic}}
> @item{@scheme['change-bold] --- change the weight of the font to @bold{bold}}
> diff --git a/collects/scribblings/guide/class.scrbl b/collects/scribblings/guide/class.scrbl
> index cb5588f..f79b425 100644
> --- a/collects/scribblings/guide/class.scrbl
> +++ b/collects/scribblings/guide/class.scrbl
> @@ -617,7 +617,7 @@ aliases.
> Suppose our @racket[fish%] programmer wants to define two class
> extensions, @racket[spots] and @racket[stripes], each of which
> includes a @racket[get-color] method. The fish's spot color should not
> -override the stripe color nor vice-versa; instead, a
> +override the stripe color nor vice versa; instead, a
> @racket[spots+stripes-fish%] should combine the two colors, which is
> not possible if @racket[spots] and @racket[stripes] are implemented as
> plain mixins. If, however, @racket[spots] and @racket[stripes] are
> diff --git a/collects/scribblings/guide/define-struct.scrbl b/collects/scribblings/guide/define-struct.scrbl
> index 02ed148..123cc18 100644
> --- a/collects/scribblings/guide/define-struct.scrbl
> +++ b/collects/scribblings/guide/define-struct.scrbl
> @@ -94,7 +94,7 @@ The @scheme[_struct-id] that appears after @scheme[struct-copy] must
> be a structure type name bound by @scheme[struct] (i.e., the
> name that cannot be used directly as an expression). The
> @scheme[_struct-expr] must produce an instance of the structure type.
> -The result is a new instance of the structure tpe that is like the old
> +The result is a new instance of the structure type that is like the old
> one, except that the field indicated by each @scheme[_field-id] gets
> the value of the corresponding @scheme[_expr].
>
> @@ -144,7 +144,7 @@ p
> ]
>
> @; ------------------------------------------------------------
> - at section[#:tag "trans-struct"]{Opaque versus Transparent Stucture Types}
> + at section[#:tag "trans-struct"]{Opaque versus Transparent Structure Types}
>
> With a structure type definition like
>
> @@ -181,7 +181,7 @@ library cannot manipulate the data in the structure except as allowed
> by the library.
>
> @; ------------------------------------------------------------
> - at section[#:tag "struct-equal"]{Stucture Comparisons}
> + at section[#:tag "struct-equal"]{Stricture Comparisons}
>
> A generic @scheme[equal?] comparison automatically recurs on the
> fields of a transparent structure type, but @scheme[equal?] defaults
> @@ -281,7 +281,7 @@ times.
> ]
>
> @; ------------------------------------------------------------
> - at section[#:tag "prefab-struct"]{Prefab Stucture Types}
> + at section[#:tag "prefab-struct"]{Prefab Structure Types}
>
> Although a @tech{transparent} structure type prints in a way that
> shows its content, the printed form of the structure cannot be used in
> @@ -463,7 +463,7 @@ A @scheme[_struct-option] always starts with a keyword:
> ]}
>
> @;-- FIXME:
> -@;-- Explain when to use guards instead of contracts, and vice-versa
> +@;-- Explain when to use guards instead of contracts, and vice versa
>
> @specspecsubform[(code:line #:guard guard-expr)]{ Specifies a
> @deftech{constructor guard} procedure to be called whenever an
> diff --git a/collects/scribblings/guide/vectors.scrbl b/collects/scribblings/guide/vectors.scrbl
> index 0e56609..738ffa9 100644
> --- a/collects/scribblings/guide/vectors.scrbl
> +++ b/collects/scribblings/guide/vectors.scrbl
> @@ -31,7 +31,7 @@ parenthesized forms in a vector constant represent symbols and lists.
> Like strings, a vector is either mutable or immutable, and vectors
> written directly as expressions are immutable.
>
> -Vector can be converted to lists and vice-versa via
> +Vector can be converted to lists and vice versa via
> @racket[list->vector] and @racket[vector->list]; such conversions are
> particularly useful in combination with predefined procedures on
> lists. When allocating extra lists seems too expensive, consider
> diff --git a/collects/scribblings/inside/custodians.scrbl b/collects/scribblings/inside/custodians.scrbl
> index c080a4d..c87a2f0 100644
> --- a/collects/scribblings/inside/custodians.scrbl
> +++ b/collects/scribblings/inside/custodians.scrbl
> @@ -48,7 +48,7 @@ typedef void (*Scheme_Close_Custodian_Client)(Scheme_Object *o,
> If @var{strong} is non-zero, then the newly managed value will
> be remembered until either the custodian shuts it down or
> @cpp{scheme_remove_managed} is called. If @var{strong} is
> -zero, the value is allowed to be garbaged collected (and automatically
> +zero, the value is allowed to be garbage collected (and automatically
> removed from the custodian).
>
> Independent of whether @var{strong} is zero, the value @var{o} is
> diff --git a/collects/scribblings/inside/eval.scrbl b/collects/scribblings/inside/eval.scrbl
> index 9185464..245451e 100644
> --- a/collects/scribblings/inside/eval.scrbl
> +++ b/collects/scribblings/inside/eval.scrbl
> @@ -112,7 +112,7 @@ Otherwise, if any application or evaluation procedure is called, the
> @cpp{scheme_multiple_count} and @cpp{scheme_multiple_array} variables
> may be modified (but the array previously referenced by
> @cpp{scheme_multiple_array} is never re-used if
> - at cpp{scheme_detatch_multiple_array} is called).
> + at cpp{scheme_detach_multiple_array} is called).
>
> The @cpp{scheme_multiple_count} and
> @cpp{scheme_multiple_array} variables only contain meaningful values
> @@ -280,7 +280,7 @@ Applies the procedure as a tail-call.}
>
> Compiles the S-expression @var{form} in the given namespace. The
> returned value can be used with @cpp{scheme_eval_compiled} et al.
> -Provide a non-zero value fo @var{writable} if the resulting compiled
> +Provide a non-zero value for @var{writable} if the resulting compiled
> object will be marshalled via @scheme[write] instead of evaluated.}
>
> @function[(Scheme_Object* scheme_expand
> diff --git a/collects/scribblings/inside/exns.scrbl b/collects/scribblings/inside/exns.scrbl
> index 0b26ce2..f318d14 100644
> --- a/collects/scribblings/inside/exns.scrbl
> +++ b/collects/scribblings/inside/exns.scrbl
> @@ -73,7 +73,7 @@ stack-allocated @cpp{mz_jmp_buf}, invoke
> and then restore @cpp{scheme_current_thread->error_buf} before
> returning a value. (3m: A stack-allocated @cpp{mz_jmp_buf} instance
> need not be registered with the garbage collector, and a
> -heap-allocated @cpp{mz_jmp_buf} should be alloctaed as atomic.)
> +heap-allocated @cpp{mz_jmp_buf} should be allocated as atomic.)
>
> However, beware that a prompt abort or the invocation of an escaping
> continuation looks like a primitive error escape. In that case, the
> @@ -217,7 +217,7 @@ that occur during while evaluating source code from a string.
>
> When embedding Racket, asynchronous break exceptions are disabled by
> default. Call @cpp{scheme_set_can_break} (which is the same as calling
> -the Racket funciton @scheme[break-enabled]) to enable or disable
> +the Racket function @scheme[break-enabled]) to enable or disable
> breaks. To enable or disable breaks during the dynamic extent of
> another evaluation (where you would use
> @scheme[with-break-parameterization] in Racket), use
> diff --git a/collects/scribblings/inside/memory.scrbl b/collects/scribblings/inside/memory.scrbl
> index 8a2f2af..19f61a5 100644
> --- a/collects/scribblings/inside/memory.scrbl
> +++ b/collects/scribblings/inside/memory.scrbl
> @@ -323,7 +323,7 @@ balanced by one call to @cpp{MZ_GC_UNREG}.
> Pointer information need not be initialized with
> @cppi{MZ_GC_VAR_IN_REG} and @cppi{MZ_GC_ARRAY_VAR_IN_REG} before
> calling @cpp{MZ_GC_REG}, and the set of registered pointers can change
> -at any time---as long as all relevent pointers are registered when a
> +at any time---as long as all relevant pointers are registered when a
> collection might occur. The following example recycles slots and
> completely de-registers information when no pointers are relevant. The
> example also illustrates how @cpp{MZ_GC_UNREG} is not needed when
> @@ -447,7 +447,7 @@ For each input file @filepath{@italic{name}.c}, the transformed output
> is @filepath{@italic{name}.3m.c}.
>
> The @DFlag{xform} mode for @|mzc| does not change allocation calls,
> -nor does it generate size, mark, or fixup predocures. It merely
> +nor does it generate size, mark, or fixup procedures. It merely
> converts the code to register local pointers.
>
> Furthermore, the @DFlag{xform} mode for @|mzc| does not handle all of
> @@ -485,7 +485,7 @@ Some specific limitations:
> function name, but it must be bound either as an argument or
> local variable with the form @cpp{@var{type} @var{id}}; the
> syntax @cpp{@var{ret_type} (*@var{id})(...)} is not
> - recgoinzed, so bind the function type to a simple name
> + recognized, so bind the function type to a simple name
> with @cpp{typedef}, first: @cpp{typedef @var{ret_type}
> (*@var{type})(...); .... @var{type} @var{id}}.}
>
> @@ -807,7 +807,7 @@ under Windows; if this size is greater than 8 MB, then 8 MB is
> assumed, instead; the size is decremented by 50000 bytes to cover a
> large margin of error; finally, the size is subtracted from (for
> stacks that grow down) or added to (for stacks that grow up) the stack
> -base in @var{stack_addr} or the auotmatically computed stack
> +base in @var{stack_addr} or the automatically computed stack
> base. Note that the 50000-byte margin of error is assumed to cover the
> difference between the actual stack start and the reported stack base,
> in addition to the margin needed for detecting and handling stack
> diff --git a/collects/scribblings/inside/misc.scrbl b/collects/scribblings/inside/misc.scrbl
> index d8c8db9..65d8102 100644
> --- a/collects/scribblings/inside/misc.scrbl
> +++ b/collects/scribblings/inside/misc.scrbl
> @@ -52,7 +52,7 @@ Returns the secondary @scheme[equal?]-hash key for @var{obj}.}
> [void* cycle_data])]{
>
> Like @cpp{scheme_equal_hash_key}, but accepts an extra value for cycle
> -tracking. This procedure is meant to be called by a hasing procedure
> +tracking. This procedure is meant to be called by a hashing procedure
> installed with @cpp{scheme_set_type_equality}.}
>
> Returns the primary @scheme[equal?]-hash key for @var{obj}.}
> diff --git a/collects/scribblings/inside/values.scrbl b/collects/scribblings/inside/values.scrbl
> index ff3a6e1..9f0beaf 100644
> --- a/collects/scribblings/inside/values.scrbl
> +++ b/collects/scribblings/inside/values.scrbl
> @@ -137,7 +137,7 @@ types:
> a caution about @cppi{SCHEME_SYM_VAL}}
>
> @item{@cppdef{scheme_keyword_type} --- @cppdef{SCHEME_KEYWORD_VAL}
> - extracts the keywors's string (without the leading hash colon) as a
> + extracts the keyword's string (without the leading hash colon) as a
> @cpp{char*} UTF-8 encoding (do not modify this string);
> @cppdef{SCHEME_KEYWORD_LEN} extracts the number of bytes in the keyword
> name (not counting the nul terminator); test for this type with
> diff --git a/collects/scribblings/reference/stx-comp.scrbl b/collects/scribblings/reference/stx-comp.scrbl
> index e717356..75e0344 100644
> --- a/collects/scribblings/reference/stx-comp.scrbl
> +++ b/collects/scribblings/reference/stx-comp.scrbl
> @@ -9,7 +9,7 @@
> boolean?]{
>
> Returns @scheme[#t] if the identifier @scheme[a-id] would bind
> - at scheme[b-id] (or vice-versa) if the identifiers were substituted in a
> + at scheme[b-id] (or vice versa) if the identifiers were substituted in a
> suitable expression context at the @tech{phase level} indicated by
> @scheme[phase-level], @scheme[#f] otherwise. A @scheme[#f] value for
> @scheme[phase-level] corresponds to the @tech{label phase level}.}
> --
> 1.7.1
>
> _________________________________________________
> For list-related administrative tasks:
> http://list.cs.brown.edu/mailman/listinfo/plt-dev
>
--
Jay McCarthy <jay at cs.byu.edu>
Assistant Professor / Brigham Young University
http://teammccarthy.org/jay
"The glory of God is Intelligence" - D&C 93
![[logo]](/logo.png){kind=logo}