[Emacs-diffs] /srv/bzr/emacs/trunk r100519: * net/rcirc.el (rcirc-nickname<, rcirc-sort-nicknames-join): Doc fix.

[Chong Yidong]

------------------------------------------------------------
revno: 100519
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Thu 2010-06-03 11:58:20 -0400
message:
  * net/rcirc.el (rcirc-nickname<, rcirc-sort-nicknames-join): Doc fix.
modified:
  lisp/ChangeLog
  lisp/net/rcirc.el

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2010-06-03 15:51:38 +0000
+++ b/lisp/ChangeLog    2010-06-03 15:58:20 +0000
@@ -1,3 +1,8 @@
+2010-06-03  Chong Yidong  <address@hidden>
+
+       * net/rcirc.el (rcirc-nickname<, rcirc-sort-nicknames-join): Doc
+       fix.
+
 2010-06-03  Stefan Monnier  <address@hidden>
 
        * net/rcirc.el (rcirc-sort-nicknames): Change default.

=== modified file 'lisp/net/rcirc.el'
--- a/lisp/net/rcirc.el 2010-06-03 15:51:38 +0000
+++ b/lisp/net/rcirc.el 2010-06-03 15:58:20 +0000
@@ -1657,13 +1657,10 @@
            (delete nick rcirc-ignore-list))))
 
 (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 @@
         (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)))