[docs] [issue20509] logging.config.fileConfig() docs could link to the config file format

Marius Gedminas report at bugs.python.org
Tue Feb 4 16:53:33 CET 2014

New submission from Marius Gedminas:

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.

assignee: docs at python
components: Documentation
files: improve-fileconfig-docs.patch
keywords: patch
messages: 210245
nosy: docs at python, mgedmin
priority: normal
severity: normal
status: open
title: logging.config.fileConfig() docs could link to the config file format
type: enhancement
versions: Python 2.7, Python 3.3
Added file: http://bugs.python.org/file33907/improve-fileconfig-docs.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list