The documentation for the atTime parameter of TimedRotatimeFileHandler is confusing

[bitdancer]

BPO	20124
Nosy	@vsajip, @bitdancer

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2016-08-24.16:50:47.083>
created_at = <Date 2014-01-04.23:48:55.960>
labels = ['docs']
title = 'The documentation for the atTime parameter of TimedRotatimeFileHandler is confusing'
updated_at = <Date 2016-08-24.16:50:47.082>
user = 'https://github.com/bitdancer'

bugs.python.org fields:

activity = <Date 2016-08-24.16:50:47.082>
actor = 'python-dev'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-08-24.16:50:47.083>
closer = 'python-dev'
components = ['Documentation']
creation = <Date 2014-01-04.23:48:55.960>
creator = 'r.david.murray'
dependencies = []
files = []
hgrepos = []
issue_num = 20124
keywords = []
message_count = 2.0
messages = ['207323', '273578']
nosy_count = 4.0
nosy_names = ['vinay.sajip', 'r.david.murray', 'docs@python', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue20124'
versions = ['Python 3.4']

[bitdancer]

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.

[python-dev]

New changeset 8d13c1f33d21 by Vinay Sajip in branch 'default':
Closes bpo-20124: clarified usage of the atTime parameter in TimedRotatingFileHandler documentation.
https://hg.python.org/cpython/rev/8d13c1f33d21