Mailman 3 November 2010 - docs

[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: Documentation files: distutils_apiref.diff keywords: patch messages: 110724 nosy: docs@python, ysj.ray priority: normal severity: normal status: open title: Distutils document problem? versions: Python 3.2 Added file: http://bugs.python.org/file18061/distutils_apiref.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9302> _______________________________________

5 18

[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 docs cross reference Namespace as a class but the Namespace class is not documented type: behavior versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8982> _______________________________________

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 "The following members and methods should") "Members and methods" should just be "attributes". ---------- assignee: docs@python components: Documentation messages: 121110 nosy: docs@python, fdrake priority: normal severity: normal status: open title: Use "member" consistently _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10403> _______________________________________

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 attaching a patch that fixes this issue for these files. The affected files are: Doc/library/idle.rst Doc/library/timeit.rst Doc/library/test.rst Doc/library/doctest.rst Doc/library/unittest.rst Doc/library/pydoc.rst Doc/library/webbrowser.rst Doc/library/compileall.rst Note1: :option: was fixed to `` markup (code snippet) as per the recommendation in the updated documentation guide Note2: I didn't patch trace.rst because it's overgoing a major rehaul (http://bugs.python.org/issue9264) ---------- assignee: docs@python components: Documentation messages: 110862 nosy: docs@python, eli.bendersky priority: normal severity: normal status: open title: Fix usage of :option: markup in stdlib ReST docs type: behavior versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9312> _______________________________________

6 26

[issue9738] Document the encoding of functions bytes arguments of the C API
by STINNER Victor May 30, 2011

May 30, 2011

New submission from STINNER Victor <victor.stinner(a)haypocalc.com>: Many C functions have bytes argument (char* type) but the encoding is not documented. If would not be a problem if the encoding was always the same, but it is not. Examples: - format of PyUnicode_FromFormat() should be encoded as ISO-8859-1 - filename of PyParser_ASTFromString() should be encoded as utf-8 - filename of PyErr_SetFromErrnoWithFilename() should be encoded to the filesystem encoding (with strict error handler, and not surrogateescape) - 's' argument of PyParser_ASTFromString() should be encoded as utf-8 if PyPARSE_IGNORE_COOKIE flag is set, otherwise the parser checks for #coding:xxx cookie (if there is no cookie, utf-8 is used) Attached patch is a try to document most low level functions. I choosed to add the name of function arguments in the headers because I consider that a header can be used as a quick documentation. I only touched .c files to change argument names. It is hard to get the right encoding, so I cannot ensure that my patch is correct. My patch is just a draft. I don't know if "encoded to utf-8" is the right expression. Or should it be "decoded as utf-8"? ---------- assignee: docs@python components: Documentation, Interpreter Core, Unicode files: encodings.patch keywords: patch messages: 115339 nosy: docs@python, haypo priority: normal severity: normal status: open title: Document the encoding of functions bytes arguments of the C API versions: Python 3.2 Added file: http://bugs.python.org/file18705/encodings.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9738> _______________________________________

5 12

[issue9382] os.popen referenced but not documented in Python 3.x
by Chris Rebert May 30, 2011

May 30, 2011

New submission from Chris Rebert <pybugs(a)rebertia.com>: http://docs.python.org/py3k/library/os.html currently mentions os.popen() in several places. The docs for os.popen() itself say: 'These functions are described in section "File Object Creation"' However, unlike the 2.x version of that section ( http://docs.python.org/library/os.html#file-object-creation ), the os.popen*() family is not documented there [or indeed anywhere] anymore ( http://docs.python.org/py3k/library/os.html#os-newstreams ); the entire section now only documents os.fdopen(). The 2.7 docs say that the os.popen*() family are deprecated, and indeed, of the family, only os.popen() seems to still exist in Python 3.x (at least based on my testing via ideone.com). Thus, from what I can see, one of the following is the case: (A) The entire os.popen*() family is supposed be gone in Python 3.x, so os.popen() should be removed entirely from both the code and the docs. (B) os.popen() is the sole legitimate survivor of its family, and should be properly documented again. (C) os.popen() was left in as a kludge, shouldn't be mentioned in the docs, and possibly should be renamed os._popen() to reflect its status. So, which one of these is it? ---------- assignee: docs@python components: Documentation messages: 111597 nosy: cvrebert, docs@python priority: normal severity: normal status: open title: os.popen referenced but not documented in Python 3.x versions: Python 3.1 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9382> _______________________________________

6 6

Re: [docs] Suggested improvement to turtle module doc
by Alexander Belopolsky April 28, 2011

April 28, 2011

Hi Richard, Thank you for your report. Please take a look at the discussion of various improvements to turtle documentation at <http://bugs.python.org/issue7061>. Please see more answers below. .. > It took me far longer than it should have to figure out how to do the > most basic thing: from an interactive prompt (or elsewhere!) get the > turtle window up and have a controllable turtle. In the end I just > guessed and created a Turtle and it worked - though I still struggle to > see where this is mentioned in the docs. > We have recently added a sidebar to the introduction in the turtle manual that should help newcomers. See <http://docs.python.org/dev/library/turtle.html>. > I believe the docs would benefit greatly from a simple example right at > the top like: > > """ > The easiest method of getting started is to open an interactive prompt > and type: > >>>> from turtle import * >>>> turtle = Turtle() > .. The turtle module provides both procedural and object-oriented interfaces. In my opinion, beginners should start with the procedural interface and this is what is now used in the sidebar. It is unfortunate that the manual uses "turtle" for both the name of the module and the name of the turtle instance used in OO examples. Any suggestions on how to improve this are welcome.

2 1

[issue9724] help('nonlocal') missing
by Cherniavsky Beni April 28, 2011

April 28, 2011

New submission from Cherniavsky Beni <cben(a)users.sf.net>: >>> help('nonlocal') no Python documentation found for 'nonlocal' As a language keyword, it clearly should have documentation. ---------- assignee: docs@python components: Documentation messages: 115266 nosy: cben, docs@python priority: normal severity: normal status: open title: help('nonlocal') missing versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9724> _______________________________________

5 5

[issue9264] trace.py documentation is incomplete
by Eli Bendersky April 27, 2011

April 27, 2011

New submission from Eli Bendersky <eliben(a)gmail.com>: The documentation of the standard 'trace' module (Doc/library/trace.rst) is sorely lacking. Arguments are not explained, some key methods are not documented at all, and the CoverageResults class isn't documented. Usage of these appears in the example but leaves the user confused as the only source of documentation for the example is the source code of the module. I'm attaching a patch that fixes this issue, by providing documentation for the missing parts. The patch was generated vs. the latest SVN trunk. ---------- assignee: docs@python components: Documentation files: tracedoc.3.patch keywords: patch messages: 110344 nosy: docs@python, eli.bendersky, tjreedy priority: normal severity: normal status: open title: trace.py documentation is incomplete type: behavior versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2 Added file: http://bugs.python.org/file18009/tracedoc.3.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9264> _______________________________________

6 35

[issue9101] reference json format in file formats chapter
by anatoly techtonik April 14, 2011

April 14, 2011

New submission from anatoly techtonik <techtonik(a)gmail.com>: Quite often people use .json files for storing configuration. Having a reference to json module from chapter "14. File Formats" would be a good pointer for those looking to .ini alternatives. ---------- assignee: docs@python components: Documentation messages: 108833 nosy: docs@python, techtonik priority: normal severity: normal status: open title: reference json format in file formats chapter versions: Python 2.6, Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9101> _______________________________________

7 22