Re: A bug in doc string of `gnus-level-unsubscribed'?

Re: A bug in doc string of `gnus-level-unsubscribed'?

[Reiner Steib]

[ Please report Gnus issues directly to the Gnus list ding@gnus.org,
  or at least Cc ding ]

On Mon, Jun 11 2007, Leo wrote:

> ,----
> | gnus-level-unsubscribed is a variable defined in `gnus-start.el'.
> | Its value is 7
> | 
> | 
> | Documentation:
> | Groups with levels less than or equal to this variable are unsubscribed.
> | Groups with levels less than `gnus-level-subscribed', which should be
> | less than this variable, are subscribed.
> `----
>
> The first 'less' should be 'more', right?

No, see (info "(gnus)Group Levels").  Is the following doc string more
clear?

,----[ <f1> v gnus-level-unsubscribed RET ]
| gnus-level-unsubscribed is a variable defined in `gnus-start.el'.
| Its value is 7
| 
| 
| Documentation:
| Groups with levels less than or equal to this variable are
| unsubscribed.  Groups with levels less than `gnus-level-subscribed',
| which should be less than this variable, are subscribed.  Groups
| with levels from `gnus-level-subscribed' (exclusive) upto this
| variable (inclusive) are unsubscribed.  See also
| `gnus-level-zombie', `gnus-level-killed' and the Info node `Group
| Levels' for details.
`----

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/

Re: A bug in doc string of `gnus-level-unsubscribed'?

[Leo]

----- Reiner Steib (2007-06-11) wrote:-----

> [ Please report Gnus issues directly to the Gnus list ding@gnus.org,
>   or at least Cc ding ]
>
> On Mon, Jun 11 2007, Leo wrote:
>
>> ,----
>> | gnus-level-unsubscribed is a variable defined in `gnus-start.el'.
>> | Its value is 7
>> | 
>> | 
>> | Documentation:
>> | Groups with levels less than or equal to this variable are unsubscribed.
>> | Groups with levels less than `gnus-level-subscribed', which should be
>> | less than this variable, are subscribed.
>> `----
>>
>> The first 'less' should be 'more', right?
>
> No, see (info "(gnus)Group Levels").  Is the following doc string more
> clear?
>
> ,----[ <f1> v gnus-level-unsubscribed RET ]
> | gnus-level-unsubscribed is a variable defined in `gnus-start.el'.
> | Its value is 7
> | 
> | 
> | Documentation:
> | Groups with levels less than or equal to this variable are
> | unsubscribed. 

This sentence looks redundant to me. The rest is clear.

> | Groups with levels less than `gnus-level-subscribed', which should
> | be less than this variable, are subscribed.  Groups with levels from
> | `gnus-level-subscribed' (exclusive) upto this variable (inclusive)
> | are unsubscribed.  See also `gnus-level-zombie', `gnus-level-killed'
> | and the Info node `Group Levels' for details.
> `----
>
> Bye, Reiner.

-- 
Leo <sdl.web AT gmail.com>                         (GPG Key: 9283AA3F)

Re: A bug in doc string of `gnus-level-unsubscribed'?

[Reiner Steib]

On Mon, Jun 11 2007, Leo wrote:

>> Is the following doc string more clear?
>>
>> ,----[ <f1> v gnus-level-unsubscribed RET ]
>> | gnus-level-unsubscribed is a variable defined in `gnus-start.el'.
>> | Its value is 7
>> | 
>> | 
>> | Documentation:
>> | Groups with levels less than or equal to this variable are
>> | unsubscribed. 
>
> This sentence looks redundant to me. The rest is clear.

The first sentence should fit in 80 columns including "  Variable: "
prepended.  So I tried to find a useful first line.  Does anyone have
a better suggestion?

>> | Groups with levels less than `gnus-level-subscribed', which should
>> | be less than this variable, are subscribed.  Groups with levels from
>> | `gnus-level-subscribed' (exclusive) upto this variable (inclusive)
>> | are unsubscribed.  See also `gnus-level-zombie', `gnus-level-killed'
>> | and the Info node `Group Levels' for details.
>> `----

Bye, Reiner.
-- 
       ,,,
      (o o)
---ooO-(_)-Ooo---  |  PGP key available  |  http://rsteib.home.pages.de/