[New-bugs-announce] [issue8696] PEP 391: Adding documentation of logging.config.dictConfig

A.M. Kuchling report at bugs.python.org
Wed May 12 16:27:13 CEST 2010


New submission from A.M. Kuchling <lists at amk.ca>:

The attached patch adds a first cut at documenting the PEP 391 dictConfig() feature.  I've taken the PEP 391 text and rearranged it to fit into the existing logging module docs.  I haven't gone through every paragraph and adjusted the markup to use Sphinx roles.

Vinay: I don't think you need to proofread every single bit of text in this patch.  I suggest you look at the following things:

* The start of the 'Configuring Logging' section, which I rewrote.

* The description of dictConfig(), which is assembled from several bits of the PEP.

* The details of the dictionary schema are moved to be first instead of last.  I therefore rewrote the paragraph in the PEP beginning "Before describing the schema in detail..." to one that begins "Describing a logging configuration requires listing..."  Is the new paragraph OK?

If you like the resulting ordering and the rewritten text, then I'll go through the rest of the text adding Sphinx markup, and commit the result.

Thanks!

----------
assignee: vinay.sajip
components: Documentation
files: pep391-docs.txt
keywords: needs review, patch
messages: 105587
nosy: akuchling, vinay.sajip
priority: low
severity: normal
stage: patch review
status: open
title: PEP 391: Adding documentation of logging.config.dictConfig
versions: Python 2.7
Added file: http://bugs.python.org/file17308/pep391-docs.txt

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


More information about the New-bugs-announce mailing list