GNU bug report logs - #9693
gnus-summary-read-group: undocumented parameters... and more!

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 9693 in the body.
You can then email your comments to 9693 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Dave Abrahams <dave <at> boostpro.com>
To: submit <at> debbugs.gnu.org (The Gnus Bugfixing Girls + Boys)
Subject: gnus-summary-read-group: undocumented parameters... and more!
Date: Fri, 07 Oct 2011 11:06:58 -0400

--8<---------------cut here---------------start------------->8---
(defun gnus-summary-read-group (group &optional show-all no-article
				      kill-buffer no-display backward
				      select-articles)
  "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."
--8<---------------cut here---------------end--------------->8---

Needs a description for KILL-BUFFER, BACKWARD, and SELECT-ARTICLES.

gnus-summary-read-group-1 should at least make reference to
gnus-summary-read-group in its docstring, for the meaning of its
variables, and the difference in its semantics should be documented.

Also it would be very good to be more explicit about what it means to
"start reading news in" a group without generating a summary buffer.
That's quite non-obvious.


No Gnus v0.18
GNU Emacs 23.3.1 (x86_64-apple-darwin10.8.0, Carbon Version 1.6.0 AppKit 1038.36)
 of 2011-09-12 on pluto.luannocracy.com
200 Leafnode NNTP Daemon, version 1.11.8 running at localhost (my fqdn: pluto.boostpro.com)
500 Unknown command

-- 
Dave Abrahams
BoostPro Computing
http://www.boostpro.com

Message #8 received at 9693 <at> debbugs.gnu.org (full text, mbox):

From: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
To: Dave Abrahams <dave <at> boostpro.com>
Cc: 9693 <at> debbugs.gnu.org
Subject: Re: bug#9693: gnus-summary-read-group: undocumented parameters... and
	more!
Date: Sat, 07 Jan 2012 02:14:10 +0100

Dave Abrahams <dave <at> boostpro.com> writes:

> (defun gnus-summary-read-group (group &optional show-all no-article
> 				      kill-buffer no-display backward
> 				      select-articles)
>   "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."
> Needs a description for KILL-BUFFER, BACKWARD, and SELECT-ARTICLES.

I've now added those.

> gnus-summary-read-group-1 should at least make reference to
> gnus-summary-read-group in its docstring, for the meaning of its
> variables, and the difference in its semantics should be documented.

The -1 function is even more internal that the other function, so I
don't really think there's a need.

> Also it would be very good to be more explicit about what it means to
> "start reading news in" a group without generating a summary buffer.

I've clarified the NO-DISPLAY parameter.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/

Message #15 received at 9693 <at> debbugs.gnu.org (full text, mbox):

From: Dave Abrahams <dave <at> boostpro.com>
To: Lars Magne Ingebrigtsen <larsi <at> gnus.org>
Cc: 9693 <at> debbugs.gnu.org
Subject: Re: bug#9693: gnus-summary-read-group: undocumented parameters... and
	more!
Date: Fri, 06 Jan 2012 23:05:06 -0500

on Fri Jan 06 2012, Lars Magne Ingebrigtsen <larsi-AT-gnus.org> wrote:

> Dave Abrahams <dave <at> boostpro.com> writes:
>
>> (defun gnus-summary-read-group (group &optional show-all no-article
>> 				      kill-buffer no-display backward
>> 				      select-articles)
>>   "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."
>> Needs a description for KILL-BUFFER, BACKWARD, and SELECT-ARTICLES.
>
> I've now added those.
>
>> gnus-summary-read-group-1 should at least make reference to
>> gnus-summary-read-group in its docstring, for the meaning of its
>> variables, and the difference in its semantics should be documented.
>
> The -1 function is even more internal that the other function, so I
> don't really think there's a need.

If you want other people to work on the code, and contribute features
and bugfixes, there's arguably a need.

>> Also it would be very good to be more explicit about what it means to
>> "start reading news in" a group without generating a summary buffer.
>
> I've clarified the NO-DISPLAY parameter.

Thanks.

-- 
Dave Abrahams
BoostPro Computing
http://www.boostpro.com

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.