(gnus-summary-read-group): Document more parameters
authorLars Magne Ingebrigtsen <larsi@stories.(none)>
Sat, 7 Jan 2012 01:13:01 +0000 (02:13 +0100)
committerLars Magne Ingebrigtsen <larsi@stories.(none)>
Sat, 7 Jan 2012 01:13:01 +0000 (02:13 +0100)
* gnus-sum.el (gnus-summary-read-group): Document more parameters
(bug#9693).

lisp/ChangeLog
lisp/gnus-sum.el

index bb5e4d4..68f3938 100644 (file)
@@ -1,5 +1,8 @@
 2012-01-07  Lars Magne Ingebrigtsen  <larsi@gnus.org>
 
+       * gnus-sum.el (gnus-summary-read-group): Document more parameters
+       (bug#9693).
+
        * mm-decode.el (mm-interactively-view-part): Use `completing-read',
        since ido doesn't work on symbols (bug#9632).
 
index 916654c..f578609 100644 (file)
@@ -3931,7 +3931,11 @@ Input should look like this: \"Sun, 14 Oct 2001 13:34:39 +0200\"."
   "Start reading news in newsgroup GROUP.
 If SHOW-ALL is non-nil, already read articles are also listed.
 If NO-ARTICLE is non-nil, no article is selected initially.
-If NO-DISPLAY, don't generate a summary buffer."
+If NO-DISPLAY, don't generate the summary buffer contents.
+If KILL-BUFFER, it should be a buffer that's killed once the new
+summary buffer has been generated.
+If BACKWARD, move point to the previous group in the group buffer
+If SELECT-ARTICLES, only select those articles from GROUP."
   (let (result)
     (while (and group
                (null (setq result