Mailman 3 March 2011 - docs

[issue8617] Non-existent variables documented
by Dave Abrahams 09 May '12

09 May '12

New submission from Dave Abrahams <dave(a)boostpro.com>: http://docs.python.org/library/site.html#module-site mentions two variables that don't appear in my Python 2.6.5 installation's site module: PYTHONNOUSERSITE New in version 2.6. PYTHONUSERBASE New in version 2.6. ---------- assignee: docs@python components: Documentation messages: 104985 nosy: dabrahams, docs@python priority: normal severity: normal status: open title: Non-existent variables documented versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8617> _______________________________________

6 13

[issue10423] s/args/options in arpgarse "Upgrading optparse code"
by Steven Bethard 31 Mar '12

31 Mar '12

New submission from Steven Bethard <steven.bethard(a)gmail.com>: >From a personal email: ---------------------------------------------------------------------- I'm not signed up for all the Python issue tracking stuff, but thought I'd let you know about a problem with the argparse doc page: http://docs.python.org/library/argparse.html It says at the end: Replace options, args = parser.parse_args() with args = parser.parse_args() and add additional ArgumentParser.add_argument() calls for the positional arguments. But I think it should be options = parser.parse_args(), not args. ---------------------------------------------------------------------- They're not options, so I don't like encouraging people to continue to call them options, but the docs should at least make clear that the namespace object that used to be called "options" is now called "args". ---------- assignee: docs@python components: Documentation messages: 121219 nosy: bethard, docs@python priority: normal severity: normal stage: needs patch status: open title: s/args/options in arpgarse "Upgrading optparse code" versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10423> _______________________________________

5 8

[issue11310] Document byte[s|array]() and byte[s|array](count) in docstrings
by Terry J. Reedy 31 Mar '12

31 Mar '12

New submission from Terry J. Reedy <tjreedy(a)udel.edu>: The entry for bytearray(source...) says " The optional source parameter can be used to initialize the array in a few different ways: ... If it is an integer, the array will have that size and will be initialized with null bytes. ... Without an argument, an array of size 0 is created. " [integer must be non-negative -- patch adds this] The entry for bytes(source...) refers back to the bytearray entry. The docstrings for bytes and bytearray omit both possibilities. Attached is a possible patch to include them. ---------- assignee: docs@python components: Documentation files: zbytes.diff keywords: patch messages: 129299 nosy: docs@python, terry.reedy priority: normal severity: normal status: open title: Document byte[s|array]() and byte[s|array](count) in docstrings versions: Python 3.2, Python 3.3 Added file: http://bugs.python.org/file20877/zbytes.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11310> _______________________________________

3 2

[issue10713] re module doesn't describe string boundaries for \b
by Ralph Corderoy 29 Feb '12

29 Feb '12

New submission from Ralph Corderoy <ralph-pythonbugs(a)inputplus.co.uk>: The re module defines \b in a regexp to need \w one side and \W the other. What about when the end of the string or line is involved? perlre(1) says that's treated as a \W. Python should precisely document that case too. ---------- assignee: docs@python components: Documentation messages: 124097 nosy: docs@python, ralph.corderoy priority: normal severity: normal status: open title: re module doesn't describe string boundaries for \b _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10713> _______________________________________

6 9

[issue9442] Update sys.version doc
by Éric Araujo 10 Feb '12

10 Feb '12

New submission from Éric Araujo <merwok(a)netwok.org>: Attaching a patch to edit mention of “build number” in library/sys. I also don’t understand “The first three characters are used to identify the version in the installation directories (where appropriate on each platform)”, maybe someone who does could enlighten me. If #5778 is rejected, the doc will need another update to mention that there may be a newline in sys.version. ---------- assignee: docs@python components: Documentation files: sys.version1.diff keywords: patch messages: 112189 nosy: docs@python, merwok priority: normal severity: normal stage: patch review status: open title: Update sys.version doc versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2 Added file: http://bugs.python.org/file18289/sys.version1.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9442> _______________________________________

4 9

[issue9021] no copy.copy problem description
by anatoly techtonik 09 Feb '12

09 Feb '12

New submission from anatoly techtonik <techtonik(a)gmail.com>: `copy` module covers very important aspect of Python programming. However its documentation doesn't provide any intro or overview of this problem starting right from details. When people meet `copy` construction in the code - the refer to module documentation and its doesn't completely answer two basic questions they have: 1. why copy module is needed (i.e. what's the problem with var assignment) 2. when and where it should be used ---------- assignee: docs@python components: Documentation messages: 108069 nosy: docs@python, techtonik priority: normal severity: normal status: open title: no copy.copy problem description versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9021> _______________________________________

5 10

[issue9637] docs do not say that urllib uses HTTP_PROXY
by Kirikaza 10 Jan '12

10 Jan '12

New submission from Kirikaza <kirikaza(a)rambler.ru>: In practice urllib reads HTTP_PROXY firstly and then if HTTP_PROXY is empty urllib reads http_proxy. Documentation (http://docs.python.org/library/urllib.html) says nothing about HTTP_PROXY. Maybe it affects all the versions of Python. ---------- assignee: docs@python components: Documentation messages: 114319 nosy: docs@python, kirikaza priority: normal severity: normal status: open title: docs do not say that urllib uses HTTP_PROXY versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9637> _______________________________________

5 11

[issue10772] Several actions for argparse arguments missing from docs
by ipatrol 05 Jan '12

05 Jan '12

New submission from ipatrol <ipatrol6010(a)yahoo.com>: I actually noticed this while trying to free the -h option for my program. The actions not mentioned are count, help, and parsers. Also for nargs, '...' and 'A...' are not documented either in the Sphinx docs or the leading docstring for the Action class. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 124654 nosy: docs@python, ipatrol priority: normal severity: normal status: open title: Several actions for argparse arguments missing from docs type: behavior versions: Python 2.7, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10772> _______________________________________

9 17

[issue9349] document argparse's help=SUPPRESS
by Steven Bethard 03 Jan '12

03 Jan '12

New submission from Steven Bethard <steven.bethard(a)gmail.com>: Argparse supports silencing help for certain options using SUPPRESS. >>> parser = argparse.ArgumentParser() >>> parser.add_argument('--foo', help=argparse.SUPPRESS) >>> parser.print_help() usage: [-h] optional arguments: -h, --help show this help message and exit This should be documented in the description of help= http://docs.python.org/library/argparse.html#help ---------- assignee: docs@python components: Documentation messages: 111320 nosy: bethard, docs@python priority: normal severity: normal status: open title: document argparse's help=SUPPRESS versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9349> _______________________________________

3 2

[issue11231] bytes() constructor is not correctly documented
by STINNER Victor 18 Dec '11

18 Dec '11

New submission from STINNER Victor <victor.stinner(a)haypocalc.com>: There are 5 different usages of the bytes() constructor: 1) bytes(iterable_of_ints) -> bytes 2) bytes(string, encoding[, errors]) -> bytes 3) bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer 4) bytes(memory_view) -> bytes 5) bytes(int) <=> b'\0' * size The docstring describes the four first usages, the documentation only (3). http://docs.python.org/dev/library/functions.html#bytes Note: bytes(3) accepts 2 other arguments, but I don't think that they are used: bytes(3, 'unused encoding', 'unused errors'). ---------- assignee: docs@python components: Documentation messages: 128739 nosy: docs@python, haypo priority: normal severity: normal status: open title: bytes() constructor is not correctly documented versions: Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________

6 9