Add note / warning about non-existent datetimes #180
Conversation
In response to [^1]. This is a known issue with datetime [^2]. [^1]: #178 (comment) [^2]: https://peps.python.org/pep-0495/#the-fold-attribute
benthorner
force-pushed
the
datetime-dst-warning
branch
from
8f83a6d to
fc88871
Compare
| # datetime(2020, 2, 29, hours=1, tzinfo=london_tz) | ||
| # => timedelta(hours=1) <== WRONG (should be 0) | ||
| # | ||
| # with pytest.raises(ValueError): # empty range |
There was a problem hiding this comment.
Ranges shouldn't be referenced in localtime - they are independent.
| @@ -35,6 +70,8 @@ def as_localtime( | |||
| Convert a tz aware datetime to localtime. | |||
|
|
|||
| Wrapper for the `django.utils.timezone` function, taking the same arguments. | |||
|
|
|||
| Warning: See Note [Non-existent datetimes] | |||
There was a problem hiding this comment.
I'm not sure this is helpful here. The warnings will only be visible to authors of this package, not callers (who will see the warning in the doc-string.
But also, I'm not sure it has any relation to this function. Once a datetime is localised, it will be fine.
The information written is good, I just don't think it has relevance being linked in this docstring.
|
Thanks for the feedback @jarshwah 💯. I agree this isn't the best place for this documentation. Arguably nowhere is as it's just documentation about Python itself - Here's another attempt, but proper documentation this time: #182. I've tried to frame it more as documentation about |
|
Closing in favour of #182. |
In response to 1.
This is a known issue with datetime 2.
Footnotes
https://github.com/octoenergy/xocto/pull/178#discussion_r1875190812 ↩
https://peps.python.org/pep-0495/#the-fold-attribute ↩