[docs] [issue20124] The documentation for the atTime parameter of TimedRotatimeFileHandler is confusing

R. David Murray report at bugs.python.org
Sun Jan 5 00:48:56 CET 2014


New submission from R. David Murray:

The docs say that you can specify 'atTime' with a 'when' of 'midnight', but that makes no sense on the face of it.  atTime with a weekday specification makes sense, but it would also make sense to use atTime with a when of D (and an interval), which is not mentioned as a possibility.  It could also make sense to use it with other intervals (in other words, use the atTime as the starting point for the rotation calculation, instead of the last mod time or 'now').  If that doesn't work it should be stated that atTime will be ignored in those cases.  

Probably all the time related entries should be rewritten with the existence of atTime in mind, in order to clarify all the possible (and not possible) interactions.

----------
assignee: docs at python
components: Documentation
messages: 207323
nosy: docs at python, r.david.murray, vinay.sajip
priority: normal
severity: normal
stage: needs patch
status: open
title: The documentation for the atTime parameter of TimedRotatimeFileHandler is confusing
versions: Python 3.4

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


More information about the docs mailing list