commit 7d7aab4312f88aab62190dd215e0cf4346df4d68
parent c68b19cd15277788783dc055e8e7354c313361a9
Author: Wolfgang Corcoran-Mathe <wcm@sigwinch.xyz>
Date: Sun, 4 Feb 2024 13:38:33 -0500
Symbols: Further Texification.
Diffstat:
1 file changed, 12 insertions(+), 13 deletions(-)
diff --git a/doc/r7rs-small/procedures/symbols.texinfo b/doc/r7rs-small/procedures/symbols.texinfo
@@ -2,15 +2,15 @@
@section Symbols
Symbols are objects whose usefulness rests on the fact that two symbols are identical (in
-the sense of eqv?) if and only if their names are spelled the same way. For instance, they
+the sense of @code{eqv?}) if and only if their names are spelled the same way. For instance, they
can be used the way enumerated values are used in other languages.
The rules for writing a symbol are exactly the same as the rules for writing an identifier;
-see sections 2.1 and 7.1.1.
+see @ref{Identifiers} and @ref{Lexical structure}.
It is guaranteed that any symbol that has been returned as part of a literal expression,
or read using the read procedure, and subsequently written out using the write
-procedure, will read back in as the identical symbol (in the sense of eqv?).
+procedure, will read back in as the identical symbol (in the sense of @code{eqv?}).
Note: Some implementations have values known as ``uninterned symbols,'' which
defeat write/read invariance, and also violate the rule that two symbols are the
@@ -19,9 +19,7 @@ the behavior of implementation-dependent extensions.
@deffn procedure symbol? obj
-Returns #t if
-
-obj is a symbol, otherwise returns #f.
+Returns @code{#t} if @var{obj} is a symbol, otherwise returns @code{#f}.
@lisp
(symbol? 'foo) @result{} #t
@@ -31,22 +29,23 @@ obj is a symbol, otherwise returns #f.
(symbol? '()) @result{} #f
(symbol? #f) @result{} #f
@end lisp
+
@end deffn
-@deffn procedure symbol=? symbol1 symbol2 symbol3 @dots{}
+@deffn procedure symbol=? @vari{symbol} @varii{symbol} @variii{symbol}@dots{}
-Returns #t if all the arguments all have the same names in the sense of string=?.
+Returns @code{#t} if all the arguments all have the same names in the sense of @code{string=?}.
Note: The definition above assumes that none of the arguments are uninterned
symbols.
+
@end deffn
@deffn procedure symbol->string symbol
Returns the name of
-
-symbol as a string, but without adding escapes. It is an error to apply mutation
-procedures like string-set! to strings returned by this procedure.
+@var{symbol} as a string, but without adding escapes. It is an error to apply mutation
+procedures like @code{string-set!} to strings returned by this procedure.
@lisp
(symbol->string 'flying-fish)
@@ -56,13 +55,13 @@ procedures like string-set! to strings returned by this procedure.
(string->symbol "Malvina"))
@result{} "Malvina"
@end lisp
+
@end deffn
@deffn procedure string->symbol string
Returns the symbol whose name is
-
-string. This procedure can create symbols with names containing special characters that
+@var{string}. This procedure can create symbols with names containing special characters that
would require escaping when written, but does not interpret escapes in its input.
@lisp
