[pydoclint
] Make example error out-of-the-box (DOC501
)
#19218
Merged
+6
−0
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
Part of #18972
This PR makes docstring-missing-exception (DOC501)'s example error out-of-the-box. Since the exceptions in the function body need to undergo name resolution to figure out if one of them is
NotImplementedError
,DOC501
won't lint if the raised name is not defined. This could be considered a limitation, but should be fine sinceF821
already covers undefined names. I did discover a different edge case, but it's not relevant to the example.Old example
New example
The "Use instead" section was also updated similarly.
Test Plan
N/A, no functionality/tests affected