char-ready?, peek-char docstring footnotes

char-ready?, peek-char docstring footnotes

[Kevin Ryde]

[-- Attachment #1: Type: text/plain, Size: 154 bytes --]

FYI,
        * ports.c (scm_char_ready_p, scm_peek_char): In docstrings, don't use
        @footnote since it doesn't go though to guile-procedures.txt.


[-- Attachment #2: ports.c.footnote.diff --]
[-- Type: text/plain, Size: 2051 bytes --]

--- ports.c.~1.178.~	2003-06-12 10:58:53.000000000 +1000
+++ ports.c	2003-07-06 10:12:23.000000000 +1000
@@ -229,14 +229,15 @@
 	    "@code{#t} then the next @code{read-char} operation on\n"
 	    "@var{port} is guaranteed not to hang.  If @var{port} is a file\n"
 	    "port at end of file then @code{char-ready?} returns @code{#t}.\n"
-	    "@footnote{@code{char-ready?} exists to make it possible for a\n"
+	    "\n"
+	    "@code{char-ready?} exists to make it possible for a\n"
 	    "program to accept characters from interactive ports without\n"
 	    "getting stuck waiting for input.  Any input editors associated\n"
 	    "with such ports must make sure that characters whose existence\n"
 	    "has been asserted by @code{char-ready?} cannot be rubbed out.\n"
 	    "If @code{char-ready?} were to return @code{#f} at end of file,\n"
 	    "a port at end of file would be indistinguishable from an\n"
-	    "interactive port that has no ready characters.}")
+	    "interactive port that has no ready characters.")
 #define FUNC_NAME s_scm_char_ready_p
 {
   scm_t_port *pt;
@@ -1187,7 +1188,9 @@
 	    "Return the next character available from @var{port},\n"
 	    "@emph{without} updating @var{port} to point to the following\n"
 	    "character.  If no more characters are available, the\n"
-	    "end-of-file object is returned.@footnote{The value returned by\n"
+	    "end-of-file object is returned.\n"
+	    "\n"
+	    "The value returned by\n"
 	    "a call to @code{peek-char} is the same as the value that would\n"
 	    "have been returned by a call to @code{read-char} on the same\n"
 	    "port.  The only difference is that the very next call to\n"
@@ -1195,7 +1198,7 @@
 	    "return the value returned by the preceding call to\n"
 	    "@code{peek-char}.  In particular, a call to @code{peek-char} on\n"
 	    "an interactive port will hang waiting for input whenever a call\n"
-	    "to @code{read-char} would have hung.}")
+	    "to @code{read-char} would have hung.")
 #define FUNC_NAME s_scm_peek_char
 {
   int c, column;

[-- Attachment #3: Type: text/plain, Size: 142 bytes --]

_______________________________________________
Guile-devel mailing list
Guile-devel@gnu.org
http://mail.gnu.org/mailman/listinfo/guile-devel