* net/rcirc.el (rcirc-nickname<, rcirc-sort-nicknames-join): Doc fix.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index a74c3999b42bd79aba75f47959bfd321eff3b5ec..dc4a5e21192ddbb848b700a030dfea8c03dbaa90 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2010-06-03  Chong Yidong  <cyd@stupidchicken.com>
+
+       * net/rcirc.el (rcirc-nickname<, rcirc-sort-nicknames-join): Doc
+       fix.
+
 2010-06-03  Stefan Monnier  <monnier@iro.umontreal.ca>
 
        * net/rcirc.el (rcirc-sort-nicknames): Change default.

diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el
index 0317cac3219126519a89eac0a7002e548b07bb45..c45fdaaf8adb74e4ba29757c560a5821242e2ea7 100644 (file)
--- a/lisp/net/rcirc.el
+++ b/lisp/net/rcirc.el
@@ -1657,13 +1657,10 @@ if NICK is also on `rcirc-ignore-list-automatic'."
            (delete nick rcirc-ignore-list))))
 \f
 (defun rcirc-nickname< (s1 s2)
-  "Compares two IRC nicknames.  Operator nicknames (@) are
-considered less than voiced nicknames (+).  Any other nicknames
-are greater than voiced nicknames.
-
-Returns t if S1 is less than S2, otherwise nil.
-
-The comparison is case-insensitive."
+  "Return t if IRC nickname S1 is less than S2, and nil otherwise.
+Operator nicknames (@) are considered less than voiced
+nicknames (+).  Any other nicknames are greater than voiced
+nicknames.  The comparison is case-insensitive."
   (setq s1 (downcase s1)
         s2 (downcase s2))
   (let* ((s1-op (eq ?@ (string-to-char s1)))
@@ -1677,12 +1674,9 @@ The comparison is case-insensitive."
         (string< s1 s2)))))
 
 (defun rcirc-sort-nicknames-join (input sep)
-  "Takes a string of nicknames and returns the string with the
-nicknames sorted.
-
+  "Return a string of sorted nicknames.
 INPUT is a string containing nicknames separated by SEP.
-
-This function is non-destructive, sorting a copy of the input."
+This function does not alter the INPUT string."
   (let* ((parts (split-string input sep t))
          (sorted (sort parts 'rcirc-nickname<)))
     (mapconcat 'identity sorted sep)))