This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Other status field flags in documentation for NNTP LIST command
Type: behavior Stage:
Components: Documentation, Extension Modules Versions: Python 3.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, jelie, pitrou
Priority: normal Keywords:

Created on 2010-11-01 20:25 by jelie, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (2)
msg120162 - (view) Author: Julien ÉLIE (jelie) Date: 2010-11-01 20:25
> +.. method:: NNTP.list(*, file=None)
> +
> +   Send a ``LIST`` command.  Return a pair ``(response, list)`` where *list* is a
> +   list of tuples representing all the groups available from this NNTP server.
> +   Each tuple has the form ``(group, last, first, flag)``, where
> +   *group* is a group name, *last* and *first* are the last and first article
> +   numbers, and *flag* is ``'y'`` if posting is allowed, ``'n'`` if not,
> +   and ``'m'`` if the newsgroup is moderated.  (Note the ordering: *last*, *first*.)

There are other values:  'x', 'j', and '=' followed by the name of a newsgroup (alias).

I believe the best would be to use what INN mentions in its documentation!  (Or otherwise, RFC 3977 and RFC 6048.)

    http://www.eyrie.org/~eagle/software/inn/docs/active.html


It would then give:

-------------------------------------------------------------------------------------
... and *flag* usually takes one of these values:

    y         Local postings and articles from peers are allowed.
    m         The group is moderated and all postings must be approved.
    n         No local postings are allowed, only articles from peers.
    j         Articles from peers are filed in the junk group instead.
    x         No local postings, and articles from peers are ignored.
    =foo.bar  Articles are filed in the group foo.bar instead.

If *flag* has another value, then the status of the newsgroup should be considered
to be unknown.
-------------------------------------------------------------------------------------


Can a bullet list be used in the documentation, to properly indent the flag values?
msg120338 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2010-11-03 18:33
Improvement committed in r86140, thank you!
History
Date User Action Args
2022-04-11 14:57:08adminsetgithub: 54494
2010-11-03 18:33:12pitrousetstatus: open -> closed
resolution: fixed
messages: + msg120338
2010-11-02 00:25:02r.david.murraysetnosy: + pitrou
2010-11-01 20:25:21jeliecreate