mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-01 12:20:26 +02:00
Code Activity

* Docstring updates for scm_symbol_to_string.

Browse source
This commit is contained in:
Neil Jerram 2000-09-02 23:16:00 +00:00
parent ec57ce2eca
commit ae42688c46
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

22
libguile/symbols.c
View file

@ -436,16 +436,16 @@ SCM_DEFINE (scm_symbol_p, "symbol?", 1, 0, 0,
SCM_DEFINE (scm_symbol_to_string, "symbol->string", 1, 0, 0,
(SCM s),
"Returns the name of @var{symbol} as a string. If the symbol was part of\n"
"an object returned as the value of a literal expression\n"
"(section @pxref{Literal expressions}) or by a call to the @samp{read} procedure,\n"
"and its name contains alphabetic characters, then the string returned\n"
"will contain characters in the implementation's preferred standard\n"
"case---some implementations will prefer upper case, others lower case.\n"
"If the symbol was returned by @samp{string->symbol}, the case of\n"
"characters in the string returned will be the same as the case in the\n"
"string that was passed to @samp{string->symbol}. It is an error\n"
"to apply mutation procedures like @code{string-set!} to strings returned\n"
"by this procedure. (r5rs)\n\n"
"an object returned as the value of a literal expression (section\n"
"@pxref{Literal expressions,,,r4rs, The Revised^4 Report on Scheme}) or\n"
"by a call to the @samp{read} procedure, and its name contains alphabetic\n"
"characters, then the string returned will contain characters in the\n"
"implementation's preferred standard case---some implementations will\n"
"prefer upper case, others lower case. If the symbol was returned by\n"
"@samp{string->symbol}, the case of characters in the string returned\n"
"will be the same as the case in the string that was passed to\n"
"@samp{string->symbol}. It is an error to apply mutation procedures like\n"
"@code{string-set!} to strings returned by this procedure. (r5rs)\n\n"
"The following examples assume that the implementation's standard case is\n"
"lower case:\n\n"
"@format\n"
@ -453,7 +453,7 @@ SCM_DEFINE (scm_symbol_to_string, "symbol->string", 1, 0, 0,
" ==> \"flying-fish\"\n"
"(symbol->string 'Martin) ==> \"martin\"\n"
"(symbol->string\n"
" (string->symbol "Malvina")) \n"
" (string->symbol \"Malvina\")) \n"
" ==> \"Malvina\"\n"
"}\n"
"@end format")