diff options
author | Antoine Pitrou <solipsis@pitrou.net> | 2010-11-03 18:32:54 (GMT) |
---|---|---|
committer | Antoine Pitrou <solipsis@pitrou.net> | 2010-11-03 18:32:54 (GMT) |
commit | 7dd1af00ad9e434ff3f60c6626fd30997c4a2dc0 (patch) | |
tree | 9ab8544ee019d0466472ab61945135a6ffced35d /Doc/library/nntplib.rst | |
parent | 4103bc09a4326a4ffd8d2dbc60a01d256d18b1f7 (diff) | |
download | cpython-7dd1af00ad9e434ff3f60c6626fd30997c4a2dc0.zip cpython-7dd1af00ad9e434ff3f60c6626fd30997c4a2dc0.tar.gz cpython-7dd1af00ad9e434ff3f60c6626fd30997c4a2dc0.tar.bz2 |
Issue #10285: explain the `flag` return field better in NNTP.list().
Patch by Julien Élie.
Diffstat (limited to 'Doc/library/nntplib.rst')
-rw-r--r-- | Doc/library/nntplib.rst | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/Doc/library/nntplib.rst b/Doc/library/nntplib.rst index 0f0b7d2..77845c8 100644 --- a/Doc/library/nntplib.rst +++ b/Doc/library/nntplib.rst @@ -188,8 +188,17 @@ response indicates an error, the method raises one of the above exceptions. 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*.) + numbers, 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 ``foo.bar`` group instead. + + If *flag* has another value, then the status of the newsgroup should be + considered unknown. This command will often return very large results. It is best to cache the results offline unless you really need to refresh them. |