(gnus-summary-setup-buffer): Document return value (bug#9697)

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 68f3938..bce0dfe 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -2,6 +2,7 @@
 
        * gnus-sum.el (gnus-summary-read-group): Document more parameters
        (bug#9693).
+       (gnus-summary-setup-buffer): Document return value (bug#9697).
 
        * mm-decode.el (mm-interactively-view-part): Use `completing-read',
        since ido doesn't work on symbols (bug#9632).

diff --git a/lisp/gnus-sum.el b/lisp/gnus-sum.el
index f578609..878a96b 100644 (file)
--- a/lisp/gnus-sum.el
+++ b/lisp/gnus-sum.el
@@ -3503,7 +3503,8 @@ display only a single character."
                                               (current-buffer))))))
 
 (defun gnus-summary-setup-buffer (group)
-  "Initialize summary buffer."
+  "Initialize summary buffer.
+If the setup was successful, non-nil is returned."
   (let ((buffer (gnus-summary-buffer-name group))
        (dead-name (concat "*Dead Summary "
                           (gnus-group-decoded-name group) "*")))