* Docstring fixes.
authorNeil Jerram <neil@ossau.uklinux.net>
Sat, 12 Aug 2000 23:15:48 +0000 (23:15 +0000)
committerNeil Jerram <neil@ossau.uklinux.net>
Sat, 12 Aug 2000 23:15:48 +0000 (23:15 +0000)
libguile/ChangeLog
libguile/numbers.c
libguile/ports.c
libguile/root.c
libguile/strports.c

index b15492f..1d82aca 100644 (file)
@@ -1,5 +1,16 @@
+2000-08-13  Neil Jerram  <neil@ossau.uklinux.net>
+
+       * root.c (s_scm_call_with_dynamic_root): Docstring fix - rogue
+       newline.
+       
 2000-08-12  Neil Jerram  <neil@ossau.uklinux.net>
 
+       * numbers.c (scm_ash): Docstring fix - missing newlines.
+
+       * ports.c (scm_port_filename): Docstring fix - missing newline.
+
+       * strports.c (scm_eval_string): Docstring fix - missing newline.
+
        * vports.c (s_scm_make_soft_port): Docstring updated so that
        example is correct.
 
index b64b8fd..b5dc2fb 100644 (file)
@@ -1114,8 +1114,8 @@ SCM_DEFINE (scm_ash, "ash", 2, 0, 0,
             (SCM n, SCM cnt),
            "The function ash performs an arithmetic shift left by CNT bits\n"
            "(or shift right, if CNT is negative).  'Arithmetic' means, that\n"
-            "the function does not guarantee to keep the bit structure of N,\n"
-            "but rather guarantees that the result will always be rounded\n"
+           "the function does not guarantee to keep the bit structure of N,\n"
+           "but rather guarantees that the result will always be rounded\n"
            "towards minus infinity.  Therefore, the results of ash and a\n"
            "corresponding bitwise shift will differ if N is negative.\n\n"
            "Formally, the function returns an integer equivalent to\n"
@@ -1123,9 +1123,9 @@ SCM_DEFINE (scm_ash, "ash", 2, 0, 0,
            "Example:\n"
            "@lisp\n"
            "(number->string (ash #b1 3) 2)\n"
-           "   @result{} \"1000\""
-           "(number->string (ash #b1010 -1) 2)"
-           "   @result{} \"101\""
+           "   @result{} \"1000\"\n"
+           "(number->string (ash #b1010 -1) 2)\n"
+           "   @result{} \"101\"\n"
            "@end lisp")
 #define FUNC_NAME s_scm_ash
 {
index 0c25369..51cbb6e 100644 (file)
@@ -1265,7 +1265,7 @@ SCM_DEFINE (scm_set_port_column_x, "set-port-column!", 2, 0, 0,
 SCM_DEFINE (scm_port_filename, "port-filename", 1, 0, 0,
             (SCM port),
            "Return the filename associated with @var{port}.  This function returns\n"
-           "the strings \"standard input\", \"standard output\" and \"standard error\""
+           "the strings \"standard input\", \"standard output\" and \"standard error\"\n"
            "when called on the current input, output and error ports respectively.")
 #define FUNC_NAME s_scm_port_filename
 {
index e58db53..0a8c7a9 100644 (file)
@@ -359,8 +359,7 @@ SCM_DEFINE (scm_call_with_dynamic_root, "call-with-dynamic-root", 2, 0, 0,
            "      (newline))\n"
            "    (lambda (errcode) errcode))))\n"
            "@end example\n\n"
-           "The problem is, on what port will @samp{fnord\n"
-           "} be displayed?  You\n"
+           "The problem is, on what port will @samp{fnord} be displayed?  You\n"
            "might expect that because of the @code{with-output-to-port} that\n"
            "it will be displayed on the port bound to @code{some-port}.  But it\n"
            "probably won't -- before evaluating the thunk, dynamic winds are\n"
index 779c100..026c5cd 100644 (file)
@@ -388,7 +388,7 @@ scm_eval_0str (const char *expr)
 SCM_DEFINE (scm_eval_string, "eval-string", 1, 0, 0, 
             (SCM string),
            "Evaluate @var{string} as the text representation of a Scheme form\n"
-           "or forms, and return whatever value they produce."
+           "or forms, and return whatever value they produce.\n"
            "Evaluation takes place in (interaction-environment).")
 #define FUNC_NAME s_scm_eval_string
 {