[Docstrings][Maintenance] Unify tuple docstrings formatting#3100
Merged
Conversation
Contributor
|
Current Coverage: 99% Mypy errors on tuple-docstrings branch: 1138 |
matthew7838
approved these changes
Jun 17, 2026
matthew7838
left a comment
matthew7838
left a comment
Collaborator
There was a problem hiding this comment.
LGTM, just minor comments.
| A tuple where the first element indicates whether the life stage has changed or remains the same, | ||
| and the second element is always None. | ||
| - Whether the life stage has changed or remains the same. | ||
| - Always None to align with the ``ANIMAL_TYPE_TO_LIFE_STAGE_UPDATE_METHOD_MAP`` mapping format. |
Collaborator
There was a problem hiding this comment.
Same as the above comment.
Collaborator
Author
There was a problem hiding this comment.
I think this one is always none based on the previous way the return docstring was written and there is no alternative to None here. I will check the others as well though to make sure they're all correct.
allisterakun
approved these changes
Jun 17, 2026
Contributor
|
Current Coverage: 99% Mypy errors on tuple-docstrings branch: 1138 |
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
3 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.
Context
Issue(s) closed by this pull request: closes #3038
What
Aligns all tuple return docstrings to the same format:
Why
Looks better and easier and more consistent to understand.
How
Findall for
-> tuple[and then went into the docstrings where applicable.Test plan
N/A no code changes.
Input Changes
Output Changes
Filter