Fix wrong parameter name in Time.diff_for_humans docstring - #1007
Merged
Secrus merged 1 commit intoSep 19, 2026
Merged
Conversation
The docstring documented ":param dt: The time to subtract from", but the parameter is named "other" and the method compares rather than subtracts. Both the name and the description were copied from Time.diff just above, which does take a "dt" argument. Time.diff_for_humans(dt=...) raises TypeError. Date.diff_for_humans, which has the identical signature, already documents ":param other: The date to compare to (defaults to today)". This mirrors that wording. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NbQSLKhdfSRcBeGWhaaV6T
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
2 participants
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.
Pull Request Check List
Time.diff_for_humansdocuments:param dt:, but the parameter isother. Sphinx drops a:param:whose name does not match the signature, so the parameter renders undocumented.Renamed the docstring parameter to
other.