classification
Title: PEP 391: Adding documentation of logging.config.dictConfig
Type: Stage: patch review
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: akuchling Nosy List: akuchling, vinay.sajip
Priority: low Keywords: patch

Created on 2010-05-12 14:27 by akuchling, last changed 2010-05-12 18:57 by akuchling. This issue is now closed.

Files
File name Uploaded Description Edit
pep391-docs.txt akuchling, 2010-05-12 14:27 Patch v1
Messages (3)
msg105587 - (view) Author: A.M. Kuchling (akuchling) * (Python committer) Date: 2010-05-12 14:27
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!
msg105595 - (view) Author: Vinay Sajip (vinay.sajip) * (Python committer) Date: 2010-05-12 17:52
Andrew - the patch looks good - thanks! A few places were "will be" could be replaced with "has been" or some such to indicate that the implementation now exists.

Please go ahead with the other changes.
msg105601 - (view) Author: A.M. Kuchling (akuchling) * (Python committer) Date: 2010-05-12 18:57
Thanks!  Committed to trunk in rev81125.
History
Date User Action Args
2010-05-12 18:57:13akuchlingsetstatus: open -> closed
assignee: vinay.sajip -> akuchling
resolution: accepted
messages: + msg105601
2010-05-12 17:52:03vinay.sajipsetkeywords: - needs review

messages: + msg105595
2010-05-12 14:27:10akuchlingcreate