Additional missing sections for Google-style docstrings#108
Open
BrianPugh wants to merge 2 commits intorr-:masterfrom
Open
Additional missing sections for Google-style docstrings#108BrianPugh wants to merge 2 commits intorr-:masterfrom
BrianPugh wants to merge 2 commits intorr-:masterfrom
Conversation
mauvilsa
reviewed
Mar 19, 2026
Comment on lines
+1100
to
+1101
| assert docstring.deprecation.version == "Use new_function instead." | ||
| assert docstring.deprecation.description is None |
Collaborator
There was a problem hiding this comment.
Description being None and version some text. This doesn't look like a correct behavior.
mauvilsa
reviewed
Mar 19, 2026
Collaborator
There was a problem hiding this comment.
Add a parametrize case to the test_compose() test to make sure that a See Also: gets composed correctly.
mauvilsa
requested changes
Mar 19, 2026
Collaborator
mauvilsa
left a comment
mauvilsa
left a comment
There was a problem hiding this comment.
Overall looks fine. But the handling of version in deprecated is very weird. I don't think this behavior should be codified in the tests. How should the behavior be, I haven't thought about. Please think about it and make a proposal.
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.
Adds missing section types for Google docstrings; genereally speaking, both Google/Numpy docstring types should support all the same section types. Sphinx lists the valid section types here. Originally discovered by domdomegg here.
Additionally, i added a small tweak to pyproject.toml;
pydoctor >= 25.4.0is incompatible with python3.8, so I just added that limitation rather than dropping python3.8 support since it's only used for document building. Functionally nothing changes, dependency solving (e.g. withuv) was simply broken before.