classification
Title: Clarify LogRecord documentation
Type: Stage: resolved
Components: Documentation Versions: Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: vinay.sajip Nosy List: cdleary, docs@python, eric.araujo, vinay.sajip
Priority: normal Keywords: patch

Created on 2010-09-11 00:20 by cdleary, last changed 2010-09-12 23:11 by eric.araujo. This issue is now closed.

Files
File name Uploaded Description Edit
pyloggingdoc.diff cdleary, 2010-09-11 00:20 LogRecord Objects changes
Messages (6)
msg116067 - (view) Author: Chris Leary (cdleary) Date: 2010-09-11 00:20
I tried to clear this section up a bit in light of the confusion here: http://stackoverflow.com/q/3687864/3594

Not sure if it applies to 3k trunk.

First documentation patch, be sure to lmk what I'm doing wrong! :-)
msg116088 - (view) Author: Vinay Sajip (vinay.sajip) * (Python committer) Date: 2010-09-11 10:27
Chris, thanks for the patch. I applied it to release27-maint and py3k branches with only minor changes (listed attributes in alphabetical order, and expanded on getMessage a bit).
msg116113 - (view) Author: Chris Leary (cdleary) Date: 2010-09-11 18:55
Okay, neat! I put them in that order so that they would correspond to the parameters to ``LogRecord.__init__`` -- do we usually do alphabetical instead?
msg116115 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-09-11 19:11
Vinay, would you mind adding references to the commits (in the form “rNNN”) so that roundup makes a link?  Thanks in advance.  Also, is this not fixed in 3.1?
msg116177 - (view) Author: Vinay Sajip (vinay.sajip) * (Python committer) Date: 2010-09-12 11:51
@Chris: I just thought that as the list was so long, alphabetic might be easier for people when they remember the attribute name but don't remember exactly what it is.

@Eric: Fair comment, I usually do but sometimes I forget. I have now also updated release31-maint, see r84733.
msg116247 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-09-12 23:11
Thanks!
History
Date User Action Args
2010-09-12 23:11:12eric.araujosetmessages: + msg116247
stage: resolved
2010-09-12 11:51:41vinay.sajipsetmessages: + msg116177
2010-09-12 11:49:17vinay.sajipsetmessages: - msg116176
2010-09-12 11:48:01vinay.sajipsetmessages: + msg116176
2010-09-11 19:11:21eric.araujosetnosy: + eric.araujo
messages: + msg116115
2010-09-11 18:55:10cdlearysetmessages: + msg116113
2010-09-11 10:27:23vinay.sajipsetstatus: open -> closed
resolution: fixed
messages: + msg116088
2010-09-11 00:39:05benjamin.petersonsetassignee: docs@python -> vinay.sajip

nosy: + vinay.sajip
2010-09-11 00:20:11cdlearycreate