This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Error and omission in logging docs
Type: Stage:
Components: Documentation Versions: Python 2.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: jlgijsbers, kjohnson, rodsenra, slmm
Priority: normal Keywords:

Created on 2004-11-07 11:35 by kjohnson, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (6)
msg23037 - (view) Author: Kent Johnson (kjohnson) * Date: 2004-11-07 11:35
- logging.handlers.TimedRotatingFileHandler and
BaseRotatingFileHandler are not mentioned in the
logging module docs at all AFAICT.

- Library Reference section 6.29.5.3
RotatingFileHandler has an error. In the description of
emit(), it says, "catering for rollover as described in
setRollover()." There is no description of
setRollover(). It seems to be referring to text that is
part of the main entry for the class.

The page is so short, I think this could be reworded to
say, "catering for rollover as described above."

(I actually found the error while looking in the docs
for a timed rollover log, and I found
TimedRotatingFileHandler while looking in the source
for setRollover(). Kind of ironic :)

Kent
msg23038 - (view) Author: Jeroen Vloothuis (slmm) Date: 2004-11-07 13:01
Logged In: YES 
user_id=387137

Patch 1061882 adds a section about the TimedRotatingFileHandler.
msg23039 - (view) Author: Johannes Gijsbers (jlgijsbers) * (Python triager) Date: 2004-11-07 14:19
Logged In: YES 
user_id=469548

Patch 1061882 has been applied.
msg23040 - (view) Author: Rodrigo Dias Arruda Senra (rodsenra) Date: 2004-11-07 14:39
Logged In: YES 
user_id=9057

All issues mentioned above should be corrected by patch 1061924,
that includes Patch 1061882 by slmm, and contemplates the
remaining issues.
msg23041 - (view) Author: Johannes Gijsbers (jlgijsbers) * (Python triager) Date: 2004-11-07 16:15
Logged In: YES 
user_id=469548

Fixed by applying patch 1061924.
msg23042 - (view) Author: Kent Johnson (kjohnson) * Date: 2004-11-07 16:52
Logged In: YES 
user_id=49695

You guys are awesome - less than 7 hours from bug submission
to patched and closed!
History
Date User Action Args
2022-04-11 14:56:07adminsetgithub: 41135
2004-11-07 11:35:29kjohnsoncreate