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>
_______________________________________
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>
_______________________________________
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: needs patch
status: open
title: PyUnicode_EncodeDecimal is undocumented
versions: Python 2.7, Python 3.2
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue8646>
_______________________________________
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>
_______________________________________
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>
_______________________________________
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>
_______________________________________
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>
_______________________________________
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>
_______________________________________
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>
_______________________________________
New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>:
Unlike sys.settrace, sys.setprofile is not described as CPython implementation detail in Doc/library/sys.rst.
----------
assignee: docs@python
components: Documentation
messages: 111199
nosy: belopolsky, docs@python
priority: normal
severity: normal
stage: needs patch
status: open
title: sys.setprofile is not described as CPython implementation detail
type: feature request
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue9331>
_______________________________________