New submission from Nick Coghlan:
It would be handy if the main OS exception docs at https://docs.python.org/3/library/exceptions.html#os-exceptions included a summary table mapping between exception types and errno names, akin to the one in the original PEP (http://www.python.org/dev/peps/pep-3151/#new-exception-classes)
----------
assignee: docs@python
components: Documentation
keywords: easy
messages: 223499
nosy: docs@python, ncoghlan
priority: normal
severity: normal
status: open
title: Add summary table for OS exception <-> errno mapping
versions: Python 3.4, Python 3.5
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue22014>
_______________________________________
New submission from Arnaut Billings:
There is no documentation for argparse.ArgumentTypeError:
http://docs.python.org/3/library/unittest.html
Though it does appear in an example and its usage is simple enough to decipher what it means, it would none the less look more professional if there was formal documentation for it. Not only on what it is, but when it should actually be used, etc...
----------
assignee: docs@python
components: Documentation
messages: 206723
nosy: arnaut-billings, docs@python
priority: normal
severity: normal
status: open
title: Missing documentation for argparse.ArgumentTypeError
versions: Python 3.3
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue20039>
_______________________________________
New submission from Eric Snow:
(related to PEP 422 and issue #17044)
The execution namespace from a class definition is passed as the third argument to the metaclass (see builtin___build_class__() in Python/bltinmodule.c). When applicable, which is almost always, the subsequent call to type.__new__() copies that namespace into a new dict which is in turn exposed via the class's __dict__.
This matters in the case where a metaclass with __prepare__() gets used (or the PEP 422 equivalent). The language reference[1] should note that the object returned by __prepare__() is copied into a new dict when the class is finally created via the metaclass.
[1] http://docs.python.org/3.4/reference/datamodel.html#customizing-class-creat…
----------
assignee: docs@python
components: Documentation
messages: 184188
nosy: docs@python, eric.snow, ncoghlan
priority: normal
severity: normal
stage: needs patch
status: open
title: language reference should specify restrictions on class namespace
type: enhancement
versions: Python 3.4
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue17422>
_______________________________________
New submission from etuardu <edonan(a)gmail.com>:
The definition of daemon thread in the current documentation reads:
«A thread can be flagged as a "daemon thread". The significance of this flag is that the entire Python program exits when only daemon threads are left. [...]»
(http://docs.python.org/library/threading.html#thread-objects)
I think it's not very clear from this that daemon threads themselves terminate when the program (main thread plus other non-daemon threads) terminates. I think this have to be said more explicitly. I'd propose a change with something like:
«A thread can be flagged as a "daemon thread", which means it will get shut down when the overall program terminates. The entire Python program exits when only daemon threads are left.»
----------
assignee: docs@python
components: Documentation
messages: 144691
nosy: docs@python, etuardu
priority: normal
severity: normal
status: open
title: Unclear behavior of daemon threads on main thread exit
type: behavior
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue13077>
_______________________________________
New submission from anatoly techtonik:
(<type 'int'>, '0755')
(<type 'int'>, '0644')
Traceback (most recent call last):
File "./tools/bootstrap.py", line 185, in extract_zip
os.fchmod(outfile, unixperm)
TypeError: an integer is required
Here the integer that is required is not `unixperm`, but `outfile`.
----------
assignee: docs@python
components: Documentation
messages: 191502
nosy: docs@python, techtonik
priority: normal
severity: normal
status: open
title: Clarify which integer is required in os.chmod() exception
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue18269>
_______________________________________
New submission from Maciej Fijalkowski:
Here: http://docs.python.org/2/reference/datamodel.html, as per python-dev discussion
----------
assignee: docs@python
components: Documentation
messages: 182364
nosy: docs@python, fijall
priority: normal
severity: normal
status: open
title: Mark __del__ not being called in cycles as an impl detail
type: behavior
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue17231>
_______________________________________
New submission from Terry J. Reedy <tjreedy(a)udel.edu>:
This doc improvement suggestion is inspired by #991196 (and subsequent duplicates) and the current discussion on py-dev in the thread
'variable name resolution in exec is incorrect'
(which is not a correct claim). I believe there is consensus that the doc for exec needs improving.
My suggestion (which others may amend) is that the following paragraph (from the 3.x builtin functions exec entry)
"In all cases, if the optional parts are omitted, the code is executed in the current scope. If only globals is provided, it must be a dictionary, which will be used for both the global and the local variables. If globals and locals are given, they are used for the global and local variables, respectively. If provided, locals can be any mapping object."
have these two sentences added:
"If only globals is provided or if onedict is provided as both globals and locals, the code is executed in a new top-level scope. If different objects are given as globals and locals, the code is executed as if it were in a class statement in a new top-level scope."
----------
assignee: docs@python
components: Documentation
messages: 106552
nosy: docs@python, tjreedy
priority: normal
severity: normal
status: open
title: Improve documentation of exec
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue8824>
_______________________________________
New submission from Éric Araujo <merwok(a)netwok.org>:
Some of the confusion encountered when writing decorators arise from the difference between a decorator (@something) and a decorator factory (@something(args)). It would help to adopt this clearer terminology in our docs: a decorator takes the decorated function as argument and does its business, a decorator factory takes some arguments and returns a decorator which wraps the decorated function.
(I think it was Nick who suggested this in a recent-ish mailing list thread.)
----------
assignee: docs@python
components: Documentation
messages: 166600
nosy: docs@python, eric.araujo, ncoghlan
priority: normal
severity: normal
status: open
title: Differentiate decorator and decorator factory in docs
versions: Python 2.7, Python 3.2, Python 3.3
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue15474>
_______________________________________
New submission from Tomi Pieviläinen:
In older versions (2.x, 3.2, 3.3) multiprocessing.reduction was only mentioned in a one example, with a one comment after it. In the 3.4dev documentation even this was dropped.
----------
assignee: docs@python
components: Documentation
messages: 196184
nosy: docs@python, tpievila
priority: normal
severity: normal
status: open
title: multiprocessing.reduction is undocumented
versions: Python 3.4
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue18837>
_______________________________________
New submission from pengyu.ut <pengyu.ut(a)gmail.com>:
Current pdf version of python documents don't have bookmarks for
sussubsection. For example, there is no bookmark for the following
section in python_2.6.5_reference.pdf. Also the bookmarks don't have
section numbers in them. I suggest to include the section numbers.
Could these features be added in future release of python document.
3.4.1 Basic customization
----------
assignee: docs@python
components: Documentation
messages: 108334
nosy: docs@python, pengyu.ut
priority: normal
severity: normal
status: open
title: Adding additional level of bookmarks and section numbers in python pdf documents.
versions: Python 2.6
_______________________________________
Python tracker <report(a)bugs.python.org>
<http://bugs.python.org/issue9056>
_______________________________________