From 679cceeda4e45ac03a10cc9c8adac1446571dd9a Mon Sep 17 00:00:00 2001 From: Neil Jerram Date: Sun, 13 Feb 2011 22:13:33 +0000 Subject: [PATCH] Misc textual editing * doc/ref/api-scheduling.texi (Asyncs): "queueing" -> "queuing". * benchmark-suite/lib.scm, doc/sources/unix.texi (Unix conventions), test-suite/lib.scm: "postpend" -> "append". * doc/ref/api-compound.texi (Array Syntax, Dictionary Types), doc/ref/api-control.texi (Catch), doc/ref/api-data.texi (Complex Numbers, Conversion, Random, Symbol Props, Symbol Uninterned), doc/ref/api-options.texi (Build Config, Common Feature Symbols), doc/ref/api-regex.texi (Match Structures), doc/ref/api-undocumented.texi, doc/ref/compiler.texi (Tree-IL, GLIL), doc/ref/data-rep.texi (Immediate objects), doc/ref/goops.texi (Slot Description Example), doc/ref/history.texi (A Scheme of Many Maintainers, Status), doc/ref/libguile-program.texi (Available Functionality), doc/ref/misc-modules.texi (Formatted Output), doc/ref/mod-getopt-long.texi (getopt-long Reference), doc/ref/posix.texi (Network Socket Address, Network Sockets and Communication), doc/ref/srfi-modules.texi (SRFI-1 Association Lists, SRFI-10, SRFI-19 String to date, SRFI-27 Random Sources), doc/ref/vm.texi (Instruction Set, Top-Level Environment Instructions, Procedure Call and Return Instructions), doc/sources/unix.texi (Unix conventions): Correct spacing after "i.e." and "e.g.". --- benchmark-suite/lib.scm | 2 +- doc/ref/api-compound.texi | 8 ++++---- doc/ref/api-control.texi | 2 +- doc/ref/api-data.texi | 10 +++++----- doc/ref/api-options.texi | 4 ++-- doc/ref/api-regex.texi | 2 +- doc/ref/api-scheduling.texi | 2 +- doc/ref/api-undocumented.texi | 2 +- doc/ref/compiler.texi | 6 +++--- doc/ref/data-rep.texi | 2 +- doc/ref/goops.texi | 2 +- doc/ref/history.texi | 4 ++-- doc/ref/libguile-program.texi | 2 +- doc/ref/misc-modules.texi | 2 +- doc/ref/mod-getopt-long.texi | 4 ++-- doc/ref/posix.texi | 6 +++--- doc/ref/srfi-modules.texi | 10 +++++----- doc/ref/vm.texi | 6 +++--- doc/sources/unix.texi | 4 ++-- test-suite/lib.scm | 2 +- 20 files changed, 41 insertions(+), 41 deletions(-) diff --git a/benchmark-suite/lib.scm b/benchmark-suite/lib.scm index 4a2bf385b..a6feed818 100644 --- a/benchmark-suite/lib.scm +++ b/benchmark-suite/lib.scm @@ -110,7 +110,7 @@ ;;;; ("multiplication"). ;;;; ;;;; WITH-BENCHMARK-PREFIX can be nested. Each WITH-BENCHMARK-PREFIX -;;;; postpends a new element to the current prefix: +;;;; appends a new element to the current prefix: ;;;; ;;;; (with-benchmark-prefix "arithmetic" ;;;; (with-benchmark-prefix "addition" diff --git a/doc/ref/api-compound.texi b/doc/ref/api-compound.texi index 095f04ca6..27ba437ad 100644 --- a/doc/ref/api-compound.texi +++ b/doc/ref/api-compound.texi @@ -1332,11 +1332,11 @@ is a uniform u8 array of rank 1. is a uniform u8 array of rank 2 with index ranges 2..3 and 3..4. @item #2() -is a two-dimensional array with index ranges 0..-1 and 0..-1, i.e. both -dimensions have length zero. +is a two-dimensional array with index ranges 0..-1 and 0..-1, i.e.@: +both dimensions have length zero. @item #2:0:2() -is a two-dimensional array with index ranges 0..-1 and 0..1, i.e. the +is a two-dimensional array with index ranges 0..-1 and 0..1, i.e.@: the first dimension has length zero, but the second has length 2. @item #0(12) @@ -2749,7 +2749,7 @@ A @dfn{dictionary} object is a data structure used to index information in a user-defined way. In standard Scheme, the main aggregate data types are lists and vectors. Lists are not really indexed at all, and vectors are indexed only by number -(e.g. @code{(vector-ref foo 5)}). Often you will find it useful +(e.g.@: @code{(vector-ref foo 5)}). Often you will find it useful to index your data on some other type; for example, in a library catalog you might want to look up a book by the name of its author. Dictionaries are used to help you organize information in diff --git a/doc/ref/api-control.texi b/doc/ref/api-control.texi index 7a5fb1e24..1f33c43b5 100644 --- a/doc/ref/api-control.texi +++ b/doc/ref/api-control.texi @@ -777,7 +777,7 @@ means that the @code{catch} applies to all exceptions, irrespective of their type. The second argument of a @code{catch} expression should be a thunk -(i.e. a procedure that accepts no arguments) that specifies the normal +(i.e.@: a procedure that accepts no arguments) that specifies the normal case code. The @code{catch} is active for the execution of this thunk, including any code called directly or indirectly by the thunk's body. Evaluation of the @code{catch} expression activates the catch and then diff --git a/doc/ref/api-data.texi b/doc/ref/api-data.texi index 4faaae32a..84a76bdf0 100644 --- a/doc/ref/api-data.texi +++ b/doc/ref/api-data.texi @@ -697,7 +697,7 @@ value, including the special values @samp{+nan.0}, @samp{+inf.0} and @deffnx {C Function} scm_complex_p (z) Return @code{#t} if @var{x} is a complex number, @code{#f} otherwise. Note that the sets of real, rational and integer -values form subsets of the set of complex numbers, i. e. the +values form subsets of the set of complex numbers, i.e.@: the predicate will also be fulfilled if @var{x} is a real, rational or integer number. @end deffn @@ -1053,7 +1053,7 @@ Return a number of the maximally precise representation expressed by the given @var{string}. @var{radix} must be an exact integer, either 2, 8, 10, or 16. If supplied, @var{radix} is a default radix that may be overridden by an explicit radix -prefix in @var{string} (e.g. "#o177"). If @var{radix} is not +prefix in @var{string} (e.g.@: "#o177"). If @var{radix} is not supplied, then the default radix is 10. If string is not a syntactically valid notation for a number, then @code{string->number} returns @code{#f}. @@ -1608,7 +1608,7 @@ through @var{end} (exclusive) bits of @var{n}. The Pseudo-random numbers are generated from a random state object, which can be created with @code{seed->random-state} or -@code{datum->random-state}. An external representation (i.e. one +@code{datum->random-state}. An external representation (i.e.@: one which can written with @code{write} and read with @code{read}) of a random state object can be obtained via @code{random-state->datum}. The @var{state} parameter to the @@ -5128,7 +5128,7 @@ code in a variable reference context @item a @dfn{function} value, which is used when the symbol appears in -code in a function name position (i.e. as the first element in an +code in a function name position (i.e.@: as the first element in an unquoted list) @item @@ -5267,7 +5267,7 @@ just returns that symbol. When not, a new symbol with the name is created and entered into the table so that it can be found later. Sometimes you might want to create a symbol that is guaranteed `fresh', -i.e. a symbol that did not exist previously. You might also want to +i.e.@: a symbol that did not exist previously. You might also want to somehow guarantee that no one else will ever unintentionally stumble across your symbol in the future. These properties of a symbol are often needed when generating code during macro expansion. When diff --git a/doc/ref/api-options.texi b/doc/ref/api-options.texi index 57ba02eee..4813864e7 100644 --- a/doc/ref/api-options.texi +++ b/doc/ref/api-options.texi @@ -59,7 +59,7 @@ The @code{effective-version} function returns the version name that should remain unchanged during a stable series. Currently that means that it omits the micro version. The effective version should be used for items like the versioned share directory name -i.e. @file{/usr/share/guile/1.6/} +i.e.@: @file{/usr/share/guile/1.6/} @lisp (version) @result{} "1.6.0" @@ -249,7 +249,7 @@ this Guile process. In general, a particular feature may be available for one of two reasons. Either because the Guile library was configured and compiled -with that feature enabled --- i.e. the feature is built into the library +with that feature enabled --- i.e.@: the feature is built into the library on your system. Or because some C or Scheme code that was dynamically loaded by Guile has added that feature to the list. diff --git a/doc/ref/api-regex.texi b/doc/ref/api-regex.texi index 61410d9a9..1435aeb05 100644 --- a/doc/ref/api-regex.texi +++ b/doc/ref/api-regex.texi @@ -402,7 +402,7 @@ Return the ending position of submatch number @var{n}. @end deffn In the following example, the result is 8, since the match runs between -characters 4 and 8 (i.e. the ``2002''). +characters 4 and 8 (i.e.@: the ``2002''). @lisp (define s (string-match "[0-9][0-9][0-9][0-9]" "blah2002foo")) diff --git a/doc/ref/api-scheduling.texi b/doc/ref/api-scheduling.texi index f7ba50801..f107cbfcb 100644 --- a/doc/ref/api-scheduling.texi +++ b/doc/ref/api-scheduling.texi @@ -79,7 +79,7 @@ System asyncs can also be queued for threads other than the current one. This way, you can cause threads to asynchronously execute arbitrary code. -User asyncs offer a convenient means of queueing procedures for future +User asyncs offer a convenient means of queuing procedures for future execution and triggering this execution. They will not be executed automatically. diff --git a/doc/ref/api-undocumented.texi b/doc/ref/api-undocumented.texi index 1e36ad8b6..1ffb3a914 100644 --- a/doc/ref/api-undocumented.texi +++ b/doc/ref/api-undocumented.texi @@ -267,7 +267,7 @@ returned by this function for @var{obj} @deffn {Scheme Procedure} %compute-slots class @deffnx {C Function} scm_sys_compute_slots (class) Return a list consisting of the names of all slots belonging to -class @var{class}, i. e. the slots of @var{class} and of all of +class @var{class}, i.e.@: the slots of @var{class} and of all of its superclasses. @end deffn diff --git a/doc/ref/compiler.texi b/doc/ref/compiler.texi index 8274a962c..fc0d9c694 100644 --- a/doc/ref/compiler.texi +++ b/doc/ref/compiler.texi @@ -357,7 +357,7 @@ Sets a lexically-bound variable. @deftpx {External Representation} (@@ @var{mod} @var{name}) @deftpx {External Representation} (@@@@ @var{mod} @var{name}) A reference to a variable in a specific module. @var{mod} should be -the name of the module, e.g. @code{(guile-user)}. +the name of the module, e.g.@: @code{(guile-user)}. If @var{public?} is true, the variable named @var{name} will be looked up in @var{mod}'s public interface, and serialized with @code{@@}; @@ -522,7 +522,7 @@ Tree-IL expressions, writing out GLIL expressions into a linear list. The compiler also keeps some state as to whether the current expression is in tail context, and whether its value will be used in future computations. This state allows the compiler not to emit code -for constant expressions that will not be used (e.g. docstrings), and +for constant expressions that will not be used (e.g.@: docstrings), and to perform tail calls when in tail position. Most optimization, such as it currently is, is performed on Tree-IL @@ -600,7 +600,7 @@ offset within a VM program. @deftp {Scheme Variable} loc Records source information for the preceding expression. @var{loc} should be an association list of containing @code{line} @code{column}, -and @code{filename} keys, e.g. as returned by +and @code{filename} keys, e.g.@: as returned by @code{source-properties}. @end deftp @deftp {Scheme Variable} diff --git a/doc/ref/data-rep.texi b/doc/ref/data-rep.texi index 7e80478d5..c16f1b1a6 100644 --- a/doc/ref/data-rep.texi +++ b/doc/ref/data-rep.texi @@ -401,7 +401,7 @@ corresponding @code{SCM} value using the @code{SCM_PACK} macro. @node Immediate objects @subsubsection Immediate objects -A Scheme object may either be an immediate, i.e. carrying all necessary +A Scheme object may either be an immediate, i.e.@: carrying all necessary information by itself, or it may contain a reference to a @dfn{cell} with additional information on the heap. Although in general it should be irrelevant for user code whether an object is an immediate or not, diff --git a/doc/ref/goops.texi b/doc/ref/goops.texi index 381dfe903..3bebd8f5b 100644 --- a/doc/ref/goops.texi +++ b/doc/ref/goops.texi @@ -537,7 +537,7 @@ other. A better solution is to use virtual slots, like this: In this class definition, the magnitude @code{m} and angle @code{a} slots are virtual, and are calculated, when referenced, from the normal -(i.e. @code{#:allocation #:instance}) slots @code{r} and @code{i}, by +(i.e.@: @code{#:allocation #:instance}) slots @code{r} and @code{i}, by calling the function defined in the relevant @code{#:slot-ref} option. Correspondingly, writing @code{m} or @code{a} leads to calling the function defined in the @code{#:slot-set!} option. Thus the diff --git a/doc/ref/history.texi b/doc/ref/history.texi index 112696c3c..62b637d81 100644 --- a/doc/ref/history.texi +++ b/doc/ref/history.texi @@ -122,7 +122,7 @@ creation of a module system, and a start at a rich POSIX interface. Only some of those features remain in Guile. There were ongoing tensions between providing a small, embeddable language, and one which -had all of the features (e.g. a graphical toolkit) that a modern Emacs +had all of the features (e.g.@: a graphical toolkit) that a modern Emacs might need. In the end, as Guile gained in uptake, the development team decided to focus on depth, documentation and orthogonality rather than on breadth. This has been the focus of Guile ever since, although @@ -279,7 +279,7 @@ from VM bytecode to native code. Still, even with an all-Guile application, sometimes you want to provide an opportunity for users to extend your program from a language with a syntax that is closer to C, or to Python. Another -interesting idea to consider is compiling e.g. Python to Guile. It's +interesting idea to consider is compiling e.g.@: Python to Guile. It's not that far-fetched of an idea: see for example IronPython or JRuby. And then there's Emacs itself. Though there is a somewhat-working Emacs diff --git a/doc/ref/libguile-program.texi b/doc/ref/libguile-program.texi index 92901c781..2c30d246e 100644 --- a/doc/ref/libguile-program.texi +++ b/doc/ref/libguile-program.texi @@ -684,7 +684,7 @@ If this approach is not enough, because the functionality that your application needs is not already available in this form, and it is impossible to write the new functionality in Scheme, you will need to write some C code. If the required function is already available in C -(e.g. in a library), all you need is a little glue to connect it to the +(e.g.@: in a library), all you need is a little glue to connect it to the world of Guile. If not, you need both to write the basic code and to plumb it into Guile. diff --git a/doc/ref/misc-modules.texi b/doc/ref/misc-modules.texi index fc35ff86d..3dbe981b8 100644 --- a/doc/ref/misc-modules.texi +++ b/doc/ref/misc-modules.texi @@ -475,7 +475,7 @@ in which case leading zeros are shown after the decimal point. @c FIXME: MANTDIGITS with negative INTDIGITS doesn't match CL spec, @c believe the spec says it ought to still show mantdigits+1 sig -@c figures, ie. leading zeros don't count towards MANTDIGITS, but it +@c figures, i.e. leading zeros don't count towards MANTDIGITS, but it @c seems to just treat MANTDIGITS as how many digits after the @c decimal point. diff --git a/doc/ref/mod-getopt-long.texi b/doc/ref/mod-getopt-long.texi index cba660b83..3d753df67 100644 --- a/doc/ref/mod-getopt-long.texi +++ b/doc/ref/mod-getopt-long.texi @@ -263,7 +263,7 @@ The @var{grammar} argument is expected to be a list of this form: @code{((@var{option} (@var{property} @var{value}) @dots{}) @dots{})} where each @var{option} is a symbol denoting the long option, but -without the two leading dashes (e.g. @code{version} if the option is +without the two leading dashes (e.g.@: @code{version} if the option is called @code{--version}). For each option, there may be list of arbitrarily many property/value @@ -284,7 +284,7 @@ If @var{bool} is @code{#t}, the option accepts a value; if it is @code{#f}, it does not; and if it is the symbol @code{optional}, the option may appear in @var{args} with or without a value. @item @code{(predicate @var{func})} -If the option accepts a value (i.e. you specified @code{(value #t)} for +If the option accepts a value (i.e.@: you specified @code{(value #t)} for this option), then @code{getopt-long} will apply @var{func} to the value, and throw an exception if it returns @code{#f}. @var{func} should be a procedure which accepts a string and returns a boolean diff --git a/doc/ref/posix.texi b/doc/ref/posix.texi index 704fe6312..469c4dadb 100644 --- a/doc/ref/posix.texi +++ b/doc/ref/posix.texi @@ -2863,7 +2863,7 @@ The following functions access the fields of a socket address object, @deffn {Scheme Procedure} sockaddr:fam sa Return the address family from socket address object @var{sa}. This -is one of the @code{AF} constants (eg. @code{AF_INET}). +is one of the @code{AF} constants (e.g.@: @code{AF_INET}). @end deffn @deffn {Scheme Procedure} sockaddr:path sa @@ -3122,7 +3122,7 @@ either a socket address object, or arguments the same as (@pxref{Network Socket Address}). The return value is unspecified. Generally a socket is only explicitly bound to a particular address -when making a server, ie. to listen on a particular port. For an +when making a server, i.e.@: to listen on a particular port. For an outgoing connection the system will assign a local address automatically, if not already bound. @@ -3177,7 +3177,7 @@ Note that on many systems the address of a socket in the @deffn {Scheme Procedure} getpeername sock @deffnx {C Function} scm_getpeername (sock) Return a socket address object which is where @var{sock} is connected -to, ie. the remote endpoint. +to, i.e.@: the remote endpoint. Note that on many systems the address of a socket in the @code{AF_UNIX} namespace cannot be read. diff --git a/doc/ref/srfi-modules.texi b/doc/ref/srfi-modules.texi index a6b98eeb4..bda7cbb37 100644 --- a/doc/ref/srfi-modules.texi +++ b/doc/ref/srfi-modules.texi @@ -976,7 +976,7 @@ extends the core @code{assoc} (@pxref{Retrieving Alist Entries}) by taking an optional @var{=} comparison procedure. The default comparison is @code{equal?}. If an @var{=} parameter is -given it's called @code{(@var{=} @var{key} @var{alistcar})}, ie. the +given it's called @code{(@var{=} @var{key} @var{alistcar})}, i.e.@: the given target @var{key} is the first argument, and a @code{car} from @var{alist} is second. @@ -1013,7 +1013,7 @@ elements will be in the same order as they were in @var{alist}. Equality is determined by the @var{=} predicate, or @code{equal?} if not given. The order in which elements are tested is unspecified, but -each equality call is made @code{(= key alistkey)}, ie. the given +each equality call is made @code{(= key alistkey)}, i.e.@: the given @var{key} parameter is first and the key from @var{alist} second. This means for instance all associations with a key greater than 5 can be removed with @code{(alist-delete 5 alist <)}. @@ -1978,7 +1978,7 @@ parameters. @var{tag}s are registered with the following procedure. @deffn {Scheme Procedure} define-reader-ctor tag proc Register @var{proc} as the constructor for a hash-comma read syntax -starting with symbol @var{tag}, ie. @nicode{#,(@var{tag} arg@dots{})}. +starting with symbol @var{tag}, i.e.@: @nicode{#,(@var{tag} arg@dots{})}. @var{proc} is called with the given arguments @code{(@var{proc} arg@dots{})} and the object it returns is the result of the read. @end deffn @@ -3010,7 +3010,7 @@ locale. @cindex date, from string @c FIXME: Can we say what happens when an incomplete date is -@c converted? Ie. fields left as 0, or what? The spec seems to be +@c converted? I.e. fields left as 0, or what? The spec seems to be @c silent on this. @defun string->date input template @@ -3337,7 +3337,7 @@ with the following procedures: @defunx random-source-state-set! source state Get and set the state of a random source. No assumptions should be made about the nature of the state object, besides it having an external -representation (i.e. it can be passed to @code{write} and subsequently +representation (i.e.@: it can be passed to @code{write} and subsequently @code{read} back). @end defun diff --git a/doc/ref/vm.texi b/doc/ref/vm.texi index 0bb9f8018..fa73f9b2e 100644 --- a/doc/ref/vm.texi +++ b/doc/ref/vm.texi @@ -371,7 +371,7 @@ their own test-and-branch instructions: @end example In addition, some Scheme primitives have their own inline -implementations, e.g. @code{cons}, and @code{list}, as we saw in the +implementations, e.g.@: @code{cons}, and @code{list}, as we saw in the previous section. So Guile's instruction set is a @emph{complete} instruction set, in @@ -524,7 +524,7 @@ relative to the module that was current when the current program was created. Alternately, the lookup may be performed relative to a particular -module, determined at compile-time (e.g. via @code{@@} or +module, determined at compile-time (e.g.@: via @code{@@} or @code{@@@@}). In that case, the cell in the object table holds a list: @code{(@var{modname} @var{sym} @var{public?})}. The symbol @var{sym} will be looked up in the module named @var{modname} (a list of @@ -673,7 +673,7 @@ If the current continuation is a multiple-value continuation, @code{return/values} pushes the number of values on the stack, then returns as in @code{return}, but to the multiple-value return address. -Otherwise if the current continuation accepts only one value, i.e. the +Otherwise if the current continuation accepts only one value, i.e.@: the multiple-value return address is @code{NULL}, then we assume the user only wants one value, and we give them the first one. If there are no values, an error is signaled. diff --git a/doc/sources/unix.texi b/doc/sources/unix.texi index 6754f8a9a..b8bf2cdb3 100644 --- a/doc/sources/unix.texi +++ b/doc/sources/unix.texi @@ -52,10 +52,10 @@ facility. @item Underscores in Unix names are converted to hyphens. @item -Procedures which destructively modify Scheme data gain postpended +Procedures which destructively modify Scheme data gain appended exclamation marks, e.g., @code{recv!}. @item -Predicates are postpended with question marks, e.g., @code{access?}. +Predicates have question marks appended, e.g., @code{access?}. @item Some names are changed to avoid conflict with dissimilar interfaces defined by scsh. diff --git a/test-suite/lib.scm b/test-suite/lib.scm index f3cbfd786..b63c5952e 100644 --- a/test-suite/lib.scm +++ b/test-suite/lib.scm @@ -178,7 +178,7 @@ ;;;; ("basic arithmetic" "subtraction"), and ;;;; ("multiplication"). ;;;; -;;;; WITH-TEST-PREFIX can be nested. Each WITH-TEST-PREFIX postpends +;;;; WITH-TEST-PREFIX can be nested. Each WITH-TEST-PREFIX appends ;;;; a new element to the current prefix: ;;;; ;;;; (with-test-prefix "arithmetic"