Mailman 3 January 2011 - docs

[issue9349] document argparse's help=SUPPRESS
by Steven Bethard Jan. 3, 2012

Jan. 3, 2012

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: … [View More]

3 2

[issue8646] PyUnicode_EncodeDecimal is undocumented
by Daniel Stutzbach Nov. 22, 2011

Nov. 22, 2011

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: PyUnicode_EncodeDecimal is undocumented (although it's referenced in passing in the documentation for PyLong_FromUnicode). There's a lengthy comment in unicodeobject.h describing PyUnicode_EncodeDecimal, which could be converted more or less directly into documentation. ---------- assignee: docs@python components: Documentation messages: 105205 nosy: docs@python, stutzbach priority: normal severity: normal stage: … [View More]

4 6

[issue10526] Minor typo in What's New in Python 2.7
by Petter Remen Oct. 9, 2011

Oct. 9, 2011

New submission from Petter Remen <petter.remen(a)gmail.com>: There's a word missing in section "PEP 372: Adding an Ordered Dictionary to collections" The ConfigParser module uses them by default, meaning that configuration files can now read, modified, and then written [...] ~~~~~~~~ should be "now be read". ---------- assignee: docs@python components: Documentation messages: 122347 nosy: Petter.Remen, docs@python priority: normal severity: normal status: open … [View More]

3 2

[issue10454] Clarify compileall options
by Éric Araujo Sept. 2, 2011

Sept. 2, 2011

New submission from Éric Araujo <merwok(a)netwok.org>: This is the help text of compileall: usage: python compileall.py [-l] [-f] [-q] [-d destdir] [-x regexp] [-i list] [directory|file ...] -l: don't recurse down -f: force rebuild even if timestamps are up-to-date -q: quiet operation -d destdir: purported directory name for error messages if no directory arguments, -l sys.path is assumed -x regexp: skip files matching the regular expression regexp the regexp is searched … [View More]

4 11

[issue9302] Distutils document problem?
by Ray.Allen Aug. 26, 2011

Aug. 26, 2011

New submission from Ray.Allen <ysj.ray(a)gmail.com>: The distutils api document for class Extension: http://docs.python.org/dev/py3k/distutils/apiref.html#distutils.core.Extens… Among the argument, in fact, the type of the arguments "sources", "include_dirs", "library_dirs", "libraries", "runtime_library_dirs" must be list, but all of them are marked as "string". I think this is a problem. Here is a patch for this, against py3k. ---------- assignee: docs@python components: … [View More]

5 18

[issue10741] PyGILState_GetThisThreadState() lacks a doc entry
by Antoine Pitrou Aug. 7, 2011

Aug. 7, 2011

New submission from Antoine Pitrou <pitrou(a)free.fr>: PyGILState_GetThisThreadState() is "documented" in Include/pystate.h but not in the official docs. It should be documented along PyGILState_Ensure() and friends. ---------- assignee: docs@python components: Documentation messages: 124394 nosy: docs@python, haypo, pitrou priority: normal severity: normal status: open title: PyGILState_GetThisThreadState() lacks a doc entry versions: Python 2.7, Python 3.1, Python 3.2 … [View More]

3 3

[issue11047] Bad description for a change
by Oren Held Aug. 6, 2011

Aug. 6, 2011

New submission from Oren Held <oren(a)held.org.il>: In the "what's new in 2.7", there is some mistake in the description of issue 7902. 7902, afaik, disables the fallback to absolute import, when requesting a relative import fails. If I got it right, the description states the opposite. ---------- assignee: docs@python components: Documentation files: whatsnew_issue_7902_fix.patch keywords: patch messages: 127317 nosy: Oren_Held, docs@python priority: normal severity: normal status: … [View More]

5 4

[issue8982] argparse docs cross reference Namespace as a class but the Namespace class is not documented
by R. David Murray July 29, 2011

July 29, 2011

New submission from R. David Murray <rdmurray(a)bitdance.com>: I wanted to find out if Namespace supported lookup by subscripting (args['someopt']), but the docs are silent on what Namespace is. (The answer, by the way, appears to be "no"; there is a feature request for this in issue 8979). ---------- assignee: bethard components: Documentation messages: 107653 nosy: bethard, docs@python, r.david.murray priority: normal severity: normal stage: needs patch status: open title: argparse … [View More]

4 9

[issue10403] Use "member" consistently
by Fred L. Drake, Jr. July 17, 2011

July 17, 2011

New submission from Fred L. Drake, Jr. <fdrake(a)acm.org>: Some portions of the documentation are using the term "member" to mean "data attribute". This appears to be an aberration at this time, but occurrences should be identified and corrected, and "Documenting Python" updated to note correct usage. Example use: http://docs.python.org/dev/py3k/library/xmlrpc.client.html#fault-objects http://docs.python.org/dev/py3k/library/urllib.request.html#basehandler-obj… (paragraph starting "… [View More]

9 24

[issue9312] Fix usage of :option: markup in stdlib ReST docs
by Eli Bendersky June 9, 2011

June 9, 2011

New submission from Eli Bendersky <eliben(a)gmail.com>: Due to a discussion on python-dev (Subject: "Markup of command-line options in Python's .rst documentation"), Georg Brandl checked in revision r82961 with a clarification of :option: markup which should only be used for Python interpreter's own flags. However, several modules in stdlib use :option: for their own command-line options, which creates confusion (these options get linked by Sphinx to unrelated Python options). I'm … [View More]

6 26