[docs] [issue15399] processName key is un-/mis-documented in 2.6 and up

Gunnlaugur Thor Briem report at bugs.python.org
Thu Jul 19 20:40:51 CEST 2012


New submission from Gunnlaugur Thor Briem <gunnlaugur at gmail.com>:

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”

----------
assignee: docs at python
components: Documentation
messages: 165852
nosy: docs at python, gthb
priority: normal
severity: normal
status: open
title: processName key is un-/mis-documented in 2.6 and up
type: enhancement
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15399>
_______________________________________


More information about the docs mailing list