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: The documentation for the atTime parameter of TimedRotatimeFileHandler is confusing
Type: Stage: resolved
Components: Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, python-dev, r.david.murray, vinay.sajip
Priority: normal Keywords:

Created on 2014-01-04 23:48 by r.david.murray, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (2)
msg207323 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2014-01-04 23:48
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.
msg273578 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-08-24 16:50
New changeset 8d13c1f33d21 by Vinay Sajip in branch 'default':
Closes #20124: clarified usage of the atTime parameter in TimedRotatingFileHandler documentation.
https://hg.python.org/cpython/rev/8d13c1f33d21
History
Date User Action Args
2022-04-11 14:57:56adminsetgithub: 64323
2016-08-24 16:50:47python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg273578

resolution: fixed
stage: needs patch -> resolved
2014-01-04 23:48:56r.david.murraycreate