Re: cmds.c patch: document omitted argument behaviour

[Markus Triska <triska@gmx.at>]

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

Richard Stallman <rms@gnu.org> writes:

>  the first line of a doc string must stand on its own.

Here's a revised version:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: cmds.patch --]
[-- Type: text/x-patch, Size: 1909 bytes --]

Index: cmds.c
===================================================================
RCS file: /sources/emacs/emacs/src/cmds.c,v
retrieving revision 1.98
diff -u -p -r1.98 cmds.c
--- cmds.c	18 Jul 2006 13:26:05 -0000	1.98
+++ cmds.c	15 Nov 2006 17:44:00 -0000
@@ -56,8 +56,9 @@ DEFUN ("forward-point", Fforward_point, 
 }
 
 DEFUN ("forward-char", Fforward_char, Sforward_char, 0, 1, "p",
-       doc: /* Move point right N characters (left if N is negative).
-On reaching end of buffer, stop and signal error.  */)
+       doc: /* Move point right (left if N is negative) N characters.
+On reaching end of buffer, stop and signal error.  N nil or omitted is
+equivalent to N = 1.  */)
      (n)
      Lisp_Object n;
 {
@@ -92,8 +93,9 @@ On reaching end of buffer, stop and sign
 }
 
 DEFUN ("backward-char", Fbackward_char, Sbackward_char, 0, 1, "p",
-       doc: /* Move point left N characters (right if N is negative).
-On attempt to pass beginning or end of buffer, stop and signal error.  */)
+       doc: /* Move point left (right if N is negative) N characters.
+On attempt to pass beginning or end of buffer, stop and signal error.
+N nil or omitted is equivalent to N = 1.  */)
      (n)
      Lisp_Object n;
 {
@@ -108,12 +110,13 @@ On attempt to pass beginning or end of b
 
 DEFUN ("forward-line", Fforward_line, Sforward_line, 0, 1, "p",
        doc: /* Move N lines forward (backward if N is negative).
+N nil or omitted is equivalent to N = 1.
 Precisely, if point is on line I, move to the start of line I + N.
 If there isn't room, go as far as possible (no error).
 Returns the count of lines left to move.  If moving forward,
 that is N - number of lines moved; if backward, N + number moved.
 With positive N, a non-empty line at the end counts as one line
-  successfully moved (for the return value).  */)
+successfully moved (for the return value).  */)
      (n)
      Lisp_Object n;
 {

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

_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel