[flake8-datetimez] Clarify docs for several rules#20778
Merged
ntBre merged 5 commits intoastral-sh:mainfrom Oct 10, 2025
Merged
[flake8-datetimez] Clarify docs for several rules#20778ntBre merged 5 commits intoastral-sh:mainfrom
flake8-datetimez] Clarify docs for several rules#20778ntBre merged 5 commits intoastral-sh:mainfrom
Conversation
ntBre
approved these changes
Oct 9, 2025
Contributor
ntBre
left a comment
There was a problem hiding this comment.
Thank you, this looks like a nice improvement! Would you mind fixing the CI failure? It looks like you just need to run cargo fmt.
I think it would also make sense to update the examples to match fix_title, at least for DTZ012 as you pointed out.
flake8-datetimez] Clarify docs for several rules
Contributor
|
Contributor
Author
|
Updated, let me know if that's what you had in mind. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #19384.
dateanddatetimeobjects.I've tried to be clearer, but there's still a contradiction in the rules as written: we say "use timezone-aware objects", but
dates are inherently timezone-naive.Also, the full docs don't always match the error message: for instance, in DTZ012, the example says to use:
while
fix_titlereturns "Usedatetime.datetime.fromtimestamp(ts, tz=...)**.date()**instead".I have left this as it was for now.
Test Plan
Ran
mkdocslocally and inspected result.