classification
Title: logging.config.fileConfig() docs could link to the config file format
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.3, Python 3.4, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: vinay.sajip Nosy List: docs@python, mgedmin, python-dev, vinay.sajip
Priority: normal Keywords: patch

Created on 2014-02-04 15:53 by mgedmin, last changed 2014-02-04 16:42 by python-dev. This issue is now closed.

Files
File name Uploaded Description Edit
improve-fileconfig-docs.patch mgedmin, 2014-02-04 15:53 patch for the docs review
Messages (2)
msg210245 - (view) Author: Marius Gedminas (mgedmin) * Date: 2014-02-04 15:53
When one is reading the description of logging.config.fileConfig()
at http://docs.python.org/3.3/library/logging.config.html#logging.config.fileConfig not immediately apparent what the "configparser-format file" should contain (i.e. the naming convention for sections, and what keys mean what.)

This is all nicely described at http://docs.python.org/3.3/library/logging.config.html#configuration-file-format but personal experience shows that users like me hit Page Down a few times and give up before they reach that part (and also they do not think to read the outline in the sidebar).

It would be nice if there was a direct link, like in the attached patch.
msg210250 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-02-04 16:42
New changeset 45aa817ec853 by Vinay Sajip in branch '2.7':
Issue #20509: Added cross-reference in documentation.
http://hg.python.org/cpython/rev/45aa817ec853

New changeset f8318b069146 by Vinay Sajip in branch '3.3':
Issue #20509: Added cross-reference in documentation.
http://hg.python.org/cpython/rev/f8318b069146

New changeset 7d0a4f89c6ce by Vinay Sajip in branch 'default':
Closes #20509: Merged documentation update from 3.3.
http://hg.python.org/cpython/rev/7d0a4f89c6ce
History
Date User Action Args
2014-02-04 16:42:30python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg210250

resolution: fixed
stage: resolved
2014-02-04 16:12:03vinay.sajipsetassignee: docs@python -> vinay.sajip

nosy: + vinay.sajip
versions: + Python 3.4
2014-02-04 15:53:33mgedmincreate