[New-bugs-announce] [issue10285] Other status field flags in documentation for NNTP LIST command

[Julien ÉLIE]

New submission from Julien ÉLIE <julien at trigofacile.com>:

> +.. 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?

----------
assignee: docs at python
components: Documentation, Extension Modules
messages: 120162
nosy: docs at python, jelie
priority: normal
severity: normal
status: open
title: Other status field flags in documentation for NNTP LIST command
type: behavior
versions: Python 3.2

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue10285>
_______________________________________