[pydoclint] Add docstring-missing-yields amd docstring-extraneous-yields (DOC402, DOC403)#12538
Merged
AlexWaygood merged 9 commits intoastral-sh:mainfrom Aug 2, 2024
Merged
Conversation
Contributor
Author
|
What happened to the ecosystem check? Why isn't it making a comment of the changes? |
Member
|
Not sure yet, it looks like the comment job can't find the artifact: https://github.com/astral-sh/ruff/actions/runs/10121063472/job/27991584964 |
Contributor
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| DOC402 | 204 | 204 | 0 | 0 | 0 |
| DOC403 | 1 | 1 | 0 | 0 | 0 |
MichaReiser
approved these changes
Aug 1, 2024
Member
MichaReiser
left a comment
There was a problem hiding this comment.
LGTM. Thank you and sorry for the wait. @AlexWaygood can you think of any other cases where a function would yield other than yield and yield from. If not, let's mege :)
AlexWaygood
reviewed
Aug 2, 2024
Member
AlexWaygood
left a comment
There was a problem hiding this comment.
Overall this looks great to me -- thanks @augustelalande!
Member
|
@augustelalande -- do you know exactly what the convention is with functions decorated with I can't immediately find anything about contextmanagers in the Sphinx or numpydoc docs, so I assume they're treated just like other functions with |
Contributor
Author
|
@AlexWaygood lol nice edge case. I'm not really sure, I couldn't find anything either. Trying to debate in my head, I'm pretty 50/50, both having and not having the violation make sense. |
AlexWaygood
approved these changes
Aug 2, 2024
Member
AlexWaygood
left a comment
There was a problem hiding this comment.
Let's ship it. Thanks again!
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
4 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.
Summary
Add
docstring-missing-yieldsamddocstring-extraneous-yields(DOC402,DOC403). These rules check that the yields defined (or not) in the docstring of a function match its implementation.The implementation is essentially a copy-paste of #12485
Part of #12434.
Test Plan
Test cases added.