Document result value of nnimap-change-group

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 77baac1..900b18a 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -6,6 +6,7 @@
        Change (random t) to (random), now that the latter is more random.
 
 2012-08-31  Dave Abrahams  <dave@boostpro.com>
+       * nnimap.el (nnimap-change-group): Document result value
 
        * auth-source.el (auth-sources): Fix macos keychain access.
 

diff --git a/lisp/nnimap.el b/lisp/nnimap.el
index 970e6b4..9b460f3 100644 (file)
--- a/lisp/nnimap.el
+++ b/lisp/nnimap.el
@@ -1683,10 +1683,14 @@ textual parts.")
            nil t))))))
 
 (defun nnimap-change-group (group &optional server no-reconnect read-only)
-  "Change group to GROUP.
+  "Change group to GROUP if non-nil.
 If SERVER is set, check that server is connected, otherwise retry
-to reconnect, unless NO-RECONNECT is set to t.
-if READ-ONLY is set, send EXAMINE rather than SELECT to the server."
+to reconnect, unless NO-RECONNECT is set to t.  Return nil if
+unsuccessful in connecting.
+If GROUP is nil, return t.
+If READ-ONLY is set, send EXAMINE rather than SELECT to the server.
+Return the server's response to the SELECT or EXAMINE command.
+"
   (let ((open-result t))
     (when (and server
               (not (nnimap-server-opened server)))