Re: ccl.el and the doc string of ccl-execute

[Pavel Janík]

   From: Richard Stallman <address@hidden>
   Date: Mon, 22 Oct 2001 07:43:44 -0600 (MDT)

   >     - char-to-string has an argument CHARACTER so the doc-string says 
CHARACTER
   >     instead of CHAR (which is IMHO good)
   > 
   > I think we should change it to CHAR, for brevity's sake.

Something like this?

--- editfns.c.~1.316.~  Sun Oct 21 19:52:08 2001
+++ editfns.c   Mon Oct 22 18:37:15 2001
@@ -164,7 +164,8 @@
 }
 
 DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
-       doc: /* Convert arg CHARACTER to a string containing that character.  
*/)
+       doc: /* Convert arg CHAR to a string containing that character.
+usage: (char-to-string CHAR)  */)
      (character)
      Lisp_Object character;
 {

   > 
   >     - modify-syntax-entry had completely bad doc-string and I think Steffan
   >     sent me new one, which uses C only once:
   > 
   >     Set syntax for character C according to string NEWENTRY.
   > 
   >     And I think this is OK too.
   > 
   > It is ok, but changing C to CHAR would be an improvement,
   > so we may as well.

And this?

--- syntax.c.~1.146.~   Sat Oct 20 22:55:29 2001
+++ syntax.c    Mon Oct 22 17:45:54 2001
@@ -974,7 +974,7 @@
 */
 DEFUN ("modify-syntax-entry", Fmodify_syntax_entry, Smodify_syntax_entry, 2, 
3, 
   "cSet syntax for character: \nsSet syntax for %s to: ",
-       doc: /* Set syntax for character C according to string NEWENTRY.
+       doc: /* Set syntax for character CHAR according to string NEWENTRY.
 The syntax is changed only for table SYNTAX_TABLE, which defaults to
  the current buffer's syntax table.
 The first character of NEWENTRY should be one of the following:
@@ -993,22 +993,23 @@
  used only if the first character is `(' or `)'.
 Any additional characters are flags.
 Defined flags are the characters 1, 2, 3, 4, b, p, and n.
- 1 means C is the start of a two-char comment start sequence.
- 2 means C is the second character of such a sequence.
- 3 means C is the start of a two-char comment end sequence.
- 4 means C is the second character of such a sequence.
+ 1 means CHAR is the start of a two-char comment start sequence.
+ 2 means CHAR is the second character of such a sequence.
+ 3 means CHAR is the start of a two-char comment end sequence.
+ 4 means CHAR is the second character of such a sequence.
 
 There can be up to two orthogonal comment sequences.  This is to support
 language modes such as C++.  By default, all comment sequences are of style
 a, but you can set the comment sequence style to b (on the second character
 of a comment-start, or the first character of a comment-end sequence) using
 this flag:
- b means C is part of comment sequence b.
- n means C is part of a nestable comment sequence.
+ b means CHAR is part of comment sequence b.
+ n means CHAR is part of a nestable comment sequence.
 
- p means C is a prefix character for `backward-prefix-chars';
+ p means CHAR is a prefix character for `backward-prefix-chars';
    such characters are treated as whitespace when they occur
-   between expressions.  */)
+   between expressions.
+usage: (modify-syntax-entry CHAR NEWENTRY &optional SYNTAX-TABLE) */)
      (c, newentry, syntax_table)
      Lisp_Object c, newentry, syntax_table;
 {

   > Over the past few years, a number of functions have had their arg
   > names or doc strings changed in order to make the arg lists accord
   > with the doc strings.  There may be other cases where we should
   > change them again, now that this new feature provides more
   > flexibility.

Yes, Miles' new syntax is great!
-- 
Pavel Janík

Oh my god! emacs uses memory that costs almost 2 DM ...
                  -- Joerg Arndt