Subject: bug#10486: closed (Re: bug#10486: Patch: Fix case in identifiers starting sentences in doc/r5rs/r5rs.texi)

From: [email-masked] (GNU bug Tracking System)
Date: Thu, 02 Feb 2012 13:50:05 +0000

Your bug report

#10486: Patch: Fix case in identifiers starting sentences in doc/r5rs/r5rs.texi

which was filed against the guile package, has been closed.

The explanation is attached below, along with your original report.
If you require more details, please reply to [email-masked].

-- 
10486: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=10486
GNU Bug Tracking System
Contact [email-masked] with problems

Subject: Re: bug#10486: Patch: Fix case in identifiers starting sentences in doc/r5rs/r5rs.texi
From: Andy Wingo <[email-masked]>
To: [email-masked]
Cc: [email-masked]
Date: Thu, 02 Feb 2012 12:29:44 +0100
List-Id: <debbugs-submit.debbugs.gnu.org>

On Thu 12 Jan 2012 17:11, Bake Timmons <[email-masked]> writes:

> The GNU coding standards advise sticking with proper case for
> identifiers, even if the identifier starts with a lowercase letter and
> appears at the beginning of a sentence.
>
> The Guile manual seems to follow this convention, with the exception of
> r5rs.texi, hence the attached patch.

Applied, thanks.  Note that as R5RS is a historical document, we
probably won't be accepting textual changes to this file, though you
probably knew that already.

Andy
-- 
http://wingolog.org/

Subject: Patch: Fix case in identifiers starting sentences in doc/r5rs/r5rs.texi
From: Bake Timmons <[email-masked]>
To: [email-masked]
Date: Thu, 12 Jan 2012 11:11:50 -0500
List-Id: <debbugs-submit.debbugs.gnu.org>

The GNU coding standards advise sticking with proper case for
identifiers, even if the identifier starts with a lowercase letter and
appears at the beginning of a sentence.

The Guile manual seems to follow this convention, with the exception of
r5rs.texi, hence the attached patch.

>From 811ad499dee562bc2fe89fa930ad412102bd5a90 Mon Sep 17 00:00:00 2001
From: Bake Timmons <[email-masked]>
Date: Thu, 12 Jan 2012 10:45:28 -0500
Subject: [PATCH] Fix case in identifiers starting sentences in
 doc/r5rs/r5rs.texi

* doc/r5rs/r5rs.texi: Use proper case of characters in identifiers starting
  sentences.
---
 doc/r5rs/r5rs.texi |  124 ++++++++++++++++++++++++++--------------------------
 1 files changed, 62 insertions(+), 62 deletions(-)

diff --git a/doc/r5rs/r5rs.texi b/doc/r5rs/r5rs.texi
index a71755b..336ce0a 100644
--- a/doc/r5rs/r5rs.texi
+++ b/doc/r5rs/r5rs.texi
@@ -2155,7 +2155,7 @@ and @r{<body>} should be a sequence of
 one or more expressions.
 
 @emph{Semantics:}
-@samp{Let*} is similar to @samp{let}, but the bindings are performed
+@samp{let*} is similar to @samp{let}, but the bindings are performed
 sequentially from left to right, and the region of a binding indicated
 @cindex @w{region}
 by @samp{(@r{<variable>} @r{<init>})} is that part of the @samp{let*}
@@ -2271,12 +2271,12 @@ output.
 @deffn {library syntax} do ((@r{<variable1>} @r{<init1>} @r{<step1>}) @dots{}) (@r{<test>} @r{<expression>} @dots{}) @r{<command>} @dots{}
 @cindex @w{do}
 
-@samp{Do} is an iteration construct.  It specifies a set of variables to
+@samp{do} is an iteration construct.  It specifies a set of variables to
 be bound, how they are to be initialized at the start, and how they are
 to be updated on each iteration.  When a termination condition is met,
 the loop exits after evaluating the @r{<expression>}s.
 
-@samp{Do} expressions are evaluated as follows:
+@samp{do} expressions are evaluated as follows:
 The @r{<init>} expressions are evaluated (in some unspecified order),
 the @r{<variable>}s are bound to fresh locations, the results of the
 @r{<init>} expressions are stored in the bindings of the
@@ -2595,7 +2595,7 @@ bindings that may surround the use of the macro.

-@samp{Let-syntax} and @samp{letrec-syntax} are
+@samp{let-syntax} and @samp{letrec-syntax} are
 analogous to @samp{let} and @samp{letrec}, but they bind
 syntactic keywords to macro transformers instead of binding variables
 to locations that contain values.  Syntactic keywords may also be
@@ -3254,7 +3254,7 @@ value (@t{#t} or @t{#f}).  An @dfn{equivalence predicate} is
 the computational analogue of a mathematical equivalence relation (it is
 symmetric, reflexive, and transitive).  Of the equivalence predicates
 described in this section, @samp{eq?} is the finest or most
-discriminating, and @samp{equal?} is the coarsest.  @samp{Eqv?} is
+discriminating, and @samp{equal?} is the coarsest.  @samp{eqv?} is
 slightly less discriminating than @samp{eq?}.  
 @ignore todo
 Pitman doesn't like
@@ -3419,9 +3419,9 @@ boolean.

 The next set of examples shows the use of @samp{eqv?} with procedures
-that have local state.  @samp{Gen-counter} must return a distinct
+that have local state.  @samp{gen-counter} must return a distinct
 procedure every time, since each procedure has its own internal counter.
-@samp{Gen-loser}, however, returns equivalent procedures each time, since
+@samp{gen-loser}, however, returns equivalent procedures each time, since
 the local state does not affect the value or side effects of the
 procedures.
 
@@ -3500,17 +3500,17 @@ bit pattern to represent both.
 
 @deffn {procedure} eq?  obj1 obj2
 
-@samp{Eq?} is similar to @samp{eqv?} except that in some cases it is
+@samp{eq?} is similar to @samp{eqv?} except that in some cases it is
 capable of discerning distinctions finer than those detectable by
 @samp{eqv?}.
 
-@samp{Eq?} and @samp{eqv?} are guaranteed to have the same
+@samp{eq?} and @samp{eqv?} are guaranteed to have the same
 behavior on symbols, booleans, the empty list, pairs, procedures,
 and non-empty
-strings and vectors.  @samp{Eq?}'s behavior on numbers and characters is
+strings and vectors.  @samp{eq?}'s behavior on numbers and characters is
 implementation-dependent, but it will always return either true or
 false, and will return true only when @samp{eqv?} would also return
-true.  @samp{Eq?} may also behave differently from @samp{eqv?} on empty
+true.  @samp{eq?} may also behave differently from @samp{eqv?} on empty
 vectors and empty strings.

@@ -3549,7 +3549,7 @@ more efficiently than @samp{eqv?}, for example, as a simple pointer
 comparison instead of as some more complicated operation.  One reason is
 that it may not be possible to compute @samp{eqv?} of two numbers in
 constant time, whereas @samp{eq?} implemented as pointer comparison will
-always finish in constant time.  @samp{Eq?} may be used like @samp{eqv?}
+always finish in constant time.  @samp{eq?} may be used like @samp{eqv?}
 in applications using procedures to implement objects with state since
 it obeys the same constraints as @samp{eqv?}.
 @end quotation
@@ -3561,10 +3561,10 @@ it obeys the same constraints as @samp{eqv?}.
 
 @deffn {library procedure} equal?  obj1 obj2
 
-@samp{Equal?} recursively compares the contents of pairs, vectors, and
+@samp{equal?} recursively compares the contents of pairs, vectors, and
 strings, applying @samp{eqv?} on other objects such as numbers and symbols.
 A rule of thumb is that objects are generally @samp{equal?} if they print
-the same.  @samp{Equal?} may fail to terminate if its arguments are
+the same.  @samp{equal?} may fail to terminate if its arguments are
 circular data structures.

@@ -4211,7 +4211,7 @@ however, they return the additive or multiplicative inverse of their argument.
 
 @deffn {library procedure} abs  x
 
-@samp{Abs} returns the absolute value of its argument.  
+@samp{abs} returns the absolute value of its argument.  
 @c - {\cf Abs} is exactness preserving when its argument is real.
 
 @format
@@ -4344,17 +4344,17 @@ More description and examples needed.

 These procedures return integers.
-@samp{Floor} returns the largest integer not larger than @var{x}.
-@samp{Ceiling} returns the smallest integer not smaller than @var{x}.
-@samp{Truncate} returns the integer closest to @var{x} whose absolute
-value is not larger than the absolute value of @var{x}.  @samp{Round} returns the
+@samp{floor} returns the largest integer not larger than @var{x}.
+@samp{ceiling} returns the smallest integer not smaller than @var{x}.
+@samp{truncate} returns the integer closest to @var{x} whose absolute
+value is not larger than the absolute value of @var{x}.  @samp{tound} returns the
 closest integer to @var{x}, rounding to even when @var{x} is halfway between two
 integers.

 @quotation
 @emph{Rationale:}
-@samp{Round} rounds to even for consistency with the default rounding
+@samp{round} rounds to even for consistency with the default rounding
 mode specified by the IEEE floating point standard.
 @end quotation
 
@@ -4393,7 +4393,7 @@ result should be passed to the @samp{inexact->exact} procedure.
 @c - \proto{rationalize}{ x}{procedure}

-@samp{Rationalize} returns the @emph{simplest} rational number
+@samp{rationalize} returns the @emph{simplest} rational number
 differing from @var{x} by no more than @var{y}.  A rational number r_1 is
 @emph{simpler}  than another rational number
 @cindex @w{simplest rational}
@@ -4556,7 +4556,7 @@ for some integer n.
 
 @quotation
 @emph{Rationale:}
-@samp{Magnitude} is the same as @code{abs} for a real argument,
+@samp{magnitude} is the same as @code{abs} for a real argument,
 @vindex @w{abs}
 but @samp{abs} must be present in all implementations, whereas
 @samp{magnitude} need only be present in implementations that support
@@ -4571,7 +4571,7 @@ general complex numbers.
 @deffn {procedure} exact->inexact  @var{z}
 @deffnx {procedure} inexact->exact  @var{z}
 
-@samp{Exact->inexact} returns an @r{inexact} representation of @var{z}.
+@samp{exact->inexact} returns an @r{inexact} representation of @var{z}.
 The value returned is the
 @r{inexact} number that is numerically closest to the argument.  
 @c %R4%%For
@@ -4580,7 +4580,7 @@ The value returned is the
 If an @r{exact} argument has no reasonably close @r{inexact} equivalent,
 then a violation of an implementation restriction may be reported.
 
-@samp{Inexact->exact} returns an @r{exact} representation of
+@samp{inexact->exact} returns an @r{exact} representation of
 @var{z}.  The value returned is the @r{exact} number that is numerically
 closest to the argument.
 @c %R4%%  For \tupe{inexact} arguments which have no
@@ -4695,7 +4695,7 @@ returns @t{#f}.
 @quotation
 @emph{Note:}
 The domain of @samp{string->number} may be restricted by implementations
-in the following ways.  @samp{String->number} is permitted to return
+in the following ways.  @samp{string->number} is permitted to return
 @t{#f} whenever @var{string} contains an explicit radix prefix.
 If all numbers supported by an implementation are real, then
 @samp{string->number} is permitted to return @t{#f} whenever
@@ -4802,7 +4802,7 @@ in programs.
 
 @deffn {library procedure} not  obj
 
-@samp{Not} returns @t{#t} if @var{obj} is false, and returns
+@samp{not} returns @t{#t} if @var{obj} is false, and returns
 @t{#f} otherwise.

@@ -4824,7 +4824,7 @@ in programs.
 
 @deffn {library procedure} boolean?  obj
 
-@samp{Boolean?} returns @t{#t} if @var{obj} is either @t{#t} or
+@samp{boolean?} returns @t{#t} if @var{obj} is either @t{#t} or
 @t{#f} and returns @t{#f} otherwise.

@@ -5011,7 +5011,7 @@ parse Scheme programs.  See section @ref{External representations}.
 
 @deffn {procedure} pair?  obj
 
-@samp{Pair?} returns @t{#t} if @var{obj} is a pair, and otherwise
+@samp{pair?} returns @t{#t} if @var{obj} is a pair, and otherwise
 returns @t{#f}.

@@ -5295,7 +5295,7 @@ in reverse order.
 
 Returns the sublist of @var{list} obtained by omitting the first @var{k}
 elements.  It is an error if @var{list} has fewer than @var{k} elements.
-@samp{List-tail} could be defined by
+@samp{list-tail} could be defined by

 @format
@@ -5356,7 +5356,7 @@ These procedures return the first sublist of @var{list} whose car is
 returned by @t{(list-tail @var{list} @var{k})} for @var{k} less
 than the length of @var{list}.  If
 @var{obj} does not occur in @var{list}, then @t{#f} (not the empty list) is
-returned.  @samp{Memq} uses @samp{eq?} to compare @var{obj} with the elements of
+returned.  @samp{memq} uses @samp{eq?} to compare @var{obj} with the elements of
 @var{list}, while @samp{memv} uses @samp{eqv?} and @samp{member} uses @samp{equal?}.

@@ -5384,7 +5384,7 @@ returned.  @samp{Memq} uses @samp{eq?} to compare @var{obj} with the elements of
 @var{alist} (for ``association list'') must be a list of
 pairs.  These procedures find the first pair in @var{alist} whose car field is @var{obj},
 and returns that pair.  If no pair in @var{alist} has @var{obj} as its
-car, then @t{#f} (not the empty list) is returned.  @samp{Assq} uses
+car, then @t{#f} (not the empty list) is returned.  @samp{assq} uses
 @samp{eq?} to compare @var{obj} with the car fields of the pairs in @var{alist},
 while @samp{assv} uses @samp{eqv?} and @samp{assoc} uses @samp{equal?}.
 
@@ -5830,7 +5830,7 @@ Returns @t{#t} if @var{obj} is a string, otherwise returns @t{#f}.
 
 @c \domain{\vr{k} must be a non-negative integer, and \var{char} must be
 @c a character.}  
-@samp{Make-string} returns a newly allocated string of length @var{k}.
+@samp{make-string} returns a newly allocated string of length @var{k}.
 If @var{char} is given, then all elements of the string are initialized
 to @var{char}, otherwise the contents of the string are unspecified.
 
@@ -5854,7 +5854,7 @@ Returns the number of characters in the given @var{string}.
 @deffn {procedure} string-ref  string @var{k}
 
 @var{k} must be a valid index of @var{string}.
-@samp{String-ref} returns character @var{k} of @var{string} using zero-origin indexing.
+@samp{string-ref} returns character @var{k} of @var{string} using zero-origin indexing.
 @end deffn

@@ -5866,7 +5866,7 @@ Returns the number of characters in the given @var{string}.
 @var{k} must be a valid index of @var{string}
 @c , and \var{char} must be a character
 .
-@samp{String-set!} stores @var{char} in element @var{k} of @var{string}
+@samp{string-set!} stores @var{char} in element @var{k} of @var{string}
 and returns an unspecified value.  
 @c  <!>
 
@@ -5892,7 +5892,7 @@ and returns an unspecified value.
 
 Returns @t{#t} if the two strings are the same length and contain the same
 characters in the same positions, otherwise returns @t{#f}.
-@samp{String-ci=?} treats
+@samp{string-ci=?} treats
 upper and lower case letters as though they were the same character, but
 @samp{string=?} treats upper and lower case as distinct characters.
 
@@ -5932,7 +5932,7 @@ must be exact integers satisfying
 
 @center 0 <= @var{start} <= @var{end} <= @w{@t{(string-length @var{string})@r{.}}}
 
-@samp{Substring} returns a newly allocated string formed from the characters of
+@samp{substring} returns a newly allocated string formed from the characters of
 @var{string} beginning with index @var{start} (inclusive) and ending with index
 @var{end} (exclusive).
 @end deffn
@@ -5951,10 +5951,10 @@ given strings.
 @deffn {library procedure} string->list  string
 @deffnx {library procedure} list->string  list
 
-@samp{String->list} returns a newly allocated list of the
-characters that make up the given string.  @samp{List->string}
+@samp{string->list} returns a newly allocated list of the
+characters that make up the given string.  @samp{list->string}
 returns a newly allocated string formed from the characters in the list
-@var{list}, which must be a list of characters. @samp{String->list}
+@var{list}, which must be a list of characters. @samp{string->list}
 and @samp{list->string} are
 inverses so far as @samp{equal?} is concerned.  
 @c Implementations that provide
@@ -6077,7 +6077,7 @@ Returns the number of elements in @var{vector} as an exact integer.
 @deffn {procedure} vector-ref  vector k
 
 @var{k} must be a valid index of @var{vector}.
-@samp{Vector-ref} returns the contents of element @var{k} of
+@samp{vector-ref} returns the contents of element @var{k} of
 @var{vector}.

@@ -6101,7 +6101,7 @@ Returns the number of elements in @var{vector} as an exact integer.
 @deffn {procedure} vector-set!  vector k obj
 
 @var{k} must be a valid index of @var{vector}.
-@samp{Vector-set!} stores @var{obj} in element @var{k} of @var{vector}.
+@samp{vector-set!} stores @var{obj} in element @var{k} of @var{vector}.
 The value returned by @samp{vector-set!} is unspecified.  
 @c  <!>
 
@@ -6124,8 +6124,8 @@ The value returned by @samp{vector-set!} is unspecified.
 @deffn {library procedure} vector->list  vector
 @deffnx {library procedure} list->vector  list
 
-@samp{Vector->list} returns a newly allocated list of the objects contained
-in the elements of @var{vector}.  @samp{List->vector} returns a newly
+@samp{vector->list} returns a newly allocated list of the objects contained
+in the elements of @var{vector}.  @samp{list->vector} returns a newly
 created vector initialized to the elements of the list @var{list}.

@@ -6215,13 +6215,13 @@ arguments.

-@deffn {library procedure} map  proc list1 list2 @dots{},
+@deffn {library procedure} map  proc list1 list2 @dots{}
 
 The @var{list}s must be lists, and @var{proc} must be a
 procedure taking as many arguments as there are @i{list}s
 and returning a single value.  If more
 than one @var{list} is given, then they must all be the same length.
-@samp{Map} applies @var{proc} element-wise to the elements of the
+@samp{map} applies @var{proc} element-wise to the elements of the
 @var{list}s and returns a list of the results, in order.
 The dynamic order in which @var{proc} is applied to the elements of the
 @var{list}s is unspecified.
@@ -6308,7 +6308,7 @@ time, the previously computed value is returned.
 @end format

-@samp{Force} and @samp{delay} are mainly intended for programs written in
+@samp{force} and @samp{delay} are mainly intended for programs written in
 functional style.  The following examples should not be considered to
 illustrate good programming style, but they illustrate the property that
 only one value is computed for a promise, no matter how many times it is
@@ -6545,7 +6545,7 @@ the answer to the top level continuation to be printed.  Normally these
 ubiquitous continuations are hidden behind the scenes and programmers do not
 think much about them.  On rare occasions, however, a programmer may
 need to deal with continuations explicitly.
-@samp{Call-with-current-continuation} allows Scheme programmers to do
+@samp{call-with-current-continuation} allows Scheme programmers to do
 that by creating a procedure that acts just like the current
 continuation.
 
@@ -6733,10 +6733,10 @@ allowed to create new bindings in the environments associated with
 @var{version} must be the exact integer @samp{5},
 corresponding to this revision of the Scheme report (the
 Revised^5 Report on Scheme).
-@samp{Scheme-report-environment} returns a specifier for an
+@samp{scheme-report-environment} returns a specifier for an
 environment that is empty except for all bindings defined in
 this report that are either required or both optional and
-supported by the implementation. @samp{Null-environment} returns
+supported by the implementation. @samp{null-environment} returns
 a specifier for an environment that is empty except for the
 (syntactic) bindings for all syntactic keywords defined in
 this report that are either required or both optional and
@@ -6875,7 +6875,7 @@ connected to it is made the default value returned by
 and the
 @var{thunk} is called with no arguments.  When the @var{thunk} returns,
 the port is closed and the previous default is restored.
-@samp{With-input-from-file} and @samp{with-output-to-file} return(s) the
+@samp{with-input-from-file} and @samp{with-output-to-file} return(s) the
 value(s) yielded by @var{thunk}.
 If an escape procedure
 is used to escape from the continuation of these procedures, their
@@ -6968,10 +6968,10 @@ The input routines have some things in common, maybe explain here.
 @deffn {library procedure} read 
 @deffnx {library procedure} read  port
 
-@samp{Read} converts external representations of Scheme objects into the
+@samp{read} converts external representations of Scheme objects into the
 objects themselves.  That is, it is a parser for the nonterminal
 <datum> (see sections @pxref{External representation} and
-@pxref{Pairs and lists}).  @samp{Read} returns the next
+@pxref{Pairs and lists}).  @samp{read} returns the next
 object parsable from the given input @var{port}, updating @var{port} to point to
 the first character past the end of the external representation of the object.
 
@@ -7055,7 +7055,7 @@ the value returned by @samp{current-input-port}.
 
 @quotation
 @emph{Rationale:}
-@samp{Char-ready?} exists to make it possible for a program to
+@samp{char-ready?} exists to make it possible for a program to
 accept characters from interactive ports without getting stuck waiting for
 input.  Any input editors associated with such ports must ensure that
 characters whose existence has been asserted by @samp{char-ready?} cannot
@@ -7087,7 +7087,7 @@ that appear in the written representation are enclosed in doublequotes, and
 within those strings backslash and doublequote characters are
 escaped by backslashes.
 Character objects are written using the @samp{#\} notation.
-@samp{Write} returns an unspecified value.  The
+@samp{write} returns an unspecified value.  The
 @var{port} argument may be omitted, in which case it defaults to the value
 returned by @samp{current-output-port}.
 
@@ -7102,14 +7102,14 @@ Writes a representation of @var{obj} to the given @var{port}.  Strings
 that appear in the written representation are not enclosed in
 doublequotes, and no characters are escaped within those strings.  Character
 objects appear in the representation as if written by @samp{write-char}
-instead of by @samp{write}.  @samp{Display} returns an unspecified value.
+instead of by @samp{write}.  @samp{display} returns an unspecified value.
 The @var{port} argument may be omitted, in which case it defaults to the
 value returned by @samp{current-output-port}.

 @quotation
 @emph{Rationale:}
-@samp{Write} is intended
+@samp{write} is intended
 for producing mach@-ine-readable output and @samp{display} is for producing
 human-readable output.  Implementations that allow ``slashification''
 within symbols will probably want @samp{write} but not @samp{display} to
@@ -7168,7 +7168,7 @@ expressions and definitions from the file and evaluates them
 sequentially.  It is unspecified whether the results of the expressions
 are printed.  The @samp{load} procedure does not affect the values
 returned by @samp{current-input-port} and @samp{current-output-port}.
-@samp{Load} returns an unspecified value.
+@samp{load} returns an unspecified value.

 @quotation
@@ -7959,7 +7959,7 @@ of the main body of the report.  The rewrite rules for derived expressions
 have been replaced with macro definitions.  There are no reserved identifiers.
 
 @item
-@samp{Syntax-rules} now allows vector patterns.
+@samp{syntax-rules} now allows vector patterns.
 
 @item
 Multiple-value returns, @samp{eval}, and @samp{dynamic-wind} have
@@ -8073,7 +8073,7 @@ programs, implementations, and other material related to Scheme.
 @c  -*- Mode: Lisp; Package: SCHEME; Syntax: Common-lisp -*-

-@samp{Integrate-system} integrates the system 
+@samp{integrate-system} integrates the system 

 @center y_k^^ = f_k(y_1, y_2, @dots{}, y_n),    k = 1, @dots{}, n
@@ -8104,8 +8104,8 @@ system states.
 @end example

-@samp{Runge-Kutta-4} takes a function, @t{f}, that produces a
-system derivative from a system state.  @samp{Runge-Kutta-4}
+@samp{runge-kutta-4} takes a function, @t{f}, that produces a
+system derivative from a system state.  @samp{runge-kutta-4}
 produces a function that takes a system state and
 produces a new system state.
 
@@ -8162,7 +8162,7 @@ produces a new system state.
 @end example

-@samp{Map-streams} is analogous to @samp{map}: it applies its first
+@samp{map-streams} is analogous to @samp{map}: it applies its first
 argument (a procedure) to all the elements of its second argument (a
 stream).
 
-- 
1.7.8.3