commit 7b2752c3d8d1949a5d8e0dff67d1ccc22143ef44 parent 714c30d01ba3cea224ebd27ee30c62b1345ffe03 Author: Wolfgang Corcoran-Mathe <wcm@sigwinch.xyz> Date: Mon, 5 Feb 2024 13:19:19 -0500 Use @rationale macro in more places. Diffstat:
5 files changed, 17 insertions(+), 9 deletions(-)
diff --git a/doc/r7rs-small/basic-concepts.texinfo b/doc/r7rs-small/basic-concepts.texinfo @@ -189,7 +189,9 @@ These locations are to be understood as conceptual, not physical. Hence, they do not necessarily correspond to memory addresses, and even if they do, the memory address might not be constant. -Rationale: In many systems it is desirable for constants (i.e. the values of +@rationale{} + +In many systems it is desirable for constants (i.e. the values of literal expressions) to reside in read-only memory. Making it an error to alter constants permits this implementation strategy, while not requiring other systems to distinguish between mutable and immutable objects. @@ -208,7 +210,7 @@ are later invoked. In the absence of captured continuations, calls could return at most once and the active calls would be those that had not yet returned. A formal definition of proper tail recursion can be found in [6]. -@subheading Rationale +@rationale{} Intuitively, no space is needed for an active tail call because the continuation that is used in the tail call has the same semantics as the diff --git a/doc/r7rs-small/procedures/control-features.texinfo b/doc/r7rs-small/procedures/control-features.texinfo @@ -297,7 +297,7 @@ with the power of @code{call-with-current-continuation}. (list-length '(a b . c)) @result{} #f @end lisp -@subheading Rationale: +@rationale{} A common use of @code{call-with-current-continuation} is for structured, non-local exits from loops or procedure bodies, but in diff --git a/doc/r7rs-small/procedures/equivalence-predicates.texinfo b/doc/r7rs-small/procedures/equivalence-predicates.texinfo @@ -254,7 +254,9 @@ from @code{eqv?}. (eq? p p)) @result{} #t @end lisp -Rationale: It will usually be possible to implement @code{eq?} much +@rationale{} + +It will usually be possible to implement @code{eq?} much more efficiently than @code{eqv?}, for example, as a simple pointer comparison instead of as some more complicated operation. One reason is that it is not always possible to compute @code{eqv?} of two numbers in diff --git a/doc/r7rs-small/procedures/input-and-output.texinfo b/doc/r7rs-small/procedures/input-and-output.texinfo @@ -44,7 +44,7 @@ If @var{proc} does not return, then the port must not be closed automatically unless it is possible to prove that the port will never again be used for a read or write operation. -@subheading Rationale: +@rationale{} Because Scheme's escape procedures have unlimited extent, it is possible to escape from the current continuation but later to @@ -318,7 +318,7 @@ returns @code{#t} then the next @code{read-char} operation on the given @var{port} is guaranteed not to hang. If the @var{port} is at end of file then @code{char-ready?} returns @code{#t}. -@subheading Rationale: +@rationale{} The @code{char-ready?} procedure exists to make it possible for a program to accept characters from interactive ports without @@ -467,7 +467,7 @@ or other types that do not have datum representations. The @code{display} procedure returns an unspecified value. -@subheading Rationale: +@rationale{} The @code{write} procedure is intended for producing machine-readable output and @code{display} for producing human-readable output. diff --git a/doc/r7rs-small/procedures/numbers.texinfo b/doc/r7rs-small/procedures/numbers.texinfo @@ -734,7 +734,9 @@ than the absolute value of @var{x}, and @code{round} returns the closest integer to @var{x}, rounding to even when @var{x} is halfway between two integers. -Rationale: The @code{round} procedure rounds to even for consistency with +@rationale{} + +The @code{round} procedure rounds to even for consistency with the default rounding mode specified by the IEEE 754 IEEE floating-point standard. @@ -1038,7 +1040,9 @@ radix prefix. Note: The error case can occur only when @var{z} is not a complex number or is a complex number with a non-rational real or imaginary part. -Rationale: If @var{z} is an inexact number and the radix is 10, then +@rationale{} + +If @var{z} is an inexact number and the radix is 10, then the above expression is normally satisfied by a result containing a decimal point. The unspecified case allows for infinities, NaNs, and unusual representations.