classification
Title: processName key is un-/mis-documented in 2.6 and up
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.2, Python 3.3, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, gthb, python-dev, r.david.murray, vinay.sajip
Priority: normal Keywords:

Created on 2012-07-19 18:40 by gthb, last changed 2012-07-20 08:51 by python-dev. This issue is now closed.

Messages (3)
msg165852 - (view) Author: Gunnlaugur Thor Briem (gthb) Date: 2012-07-19 18:40
The ``processName`` format mapping key in logging formats works in versions 2.6.*, 2.7.* and 3.1.* onwards; in 2.5 and down and in 3.0.1, ``format`` fails when this key is present in the format.

But in 2.6.8 docs, this mapping key is not documented:

http://docs.python.org/release/2.6.8/library/logging.html
http://docs.python.org/release/3.0.1/library/logging.html

and in 2.7.3 and 3.1.5 and 3.2.3 docs, it is documented but there is no note that it is new in any particular version (unlike ``funcName``, for which there is “Changed in version 2.5: funcName was added”):

http://docs.python.org/release/2.7.3/library/logging.html
http://docs.python.org/release/3.1.5/library/logging.html
http://docs.python.org/release/3.2.3/library/logging.html

Consistent with (what I think are the) version note conventions, these seem like the actions to take:

- In 2.6 docs, add processName, and insert the note “Changed in version 2.6: processName was added”

- In 2.7 docs, insert that same note

- In docs for 3.1 and up, insert the note “Changed in version 3.1: processName was added”
msg165860 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2012-07-19 19:19
We only update the docs for the active versions, so only 2.7, 3.2, and default (3.3) are going to get updated.
msg165904 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-07-20 08:51
New changeset 204be25f24bd by Vinay Sajip in branch '2.7':
Issue #15399: Added versionchanged for processName.
http://hg.python.org/cpython/rev/204be25f24bd

New changeset 6b771075cfa3 by Vinay Sajip in branch '3.2':
Issue #15399: Added versionchanged for processName.
http://hg.python.org/cpython/rev/6b771075cfa3

New changeset 4b5e8f7d1ac4 by Vinay Sajip in branch 'default':
Closes #15399: merged documentation fix from 3.2.
http://hg.python.org/cpython/rev/4b5e8f7d1ac4
History
Date User Action Args
2012-07-20 08:51:36python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg165904

resolution: fixed
stage: resolved
2012-07-19 19:19:58r.david.murraysetnosy: + vinay.sajip, r.david.murray

messages: + msg165860
versions: - Python 2.6, Python 3.1, Python 3.4
2012-07-19 18:40:50gthbcreate