Include AssertionError in Raises section #215
Merged
+164
−22
Conversation
This file contains 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
Should the language of DOC5* be modified to include assert? Should it be a new DOC rule? Closes jsh9#213.
jsh9
reviewed
Feb 16, 2025
| @@ -114,8 +114,8 @@ def getRaisedExceptions(node: FuncOrAsyncFuncDef) -> list[str]: | |||
|
|
|||
| def _getRaisedExceptions( | |||
| node: FuncOrAsyncFuncDef, | |||
| ) -> Generator[str, None, None]: | |||
| """Yield the raised exceptions in a function node""" | |||
| ) -> Iterator[str, None, None]: | |||
There was a problem hiding this comment.
Hi @pechersky , using Generator[str, None, None] is preferred here. You can read more here: https://jsh9.github.io/pydoclint/notes_generator_vs_iterator.html
jsh9
reviewed
Feb 16, 2025
| @@ -189,7 +192,7 @@ def _getRaisedExceptions( | |||
|
|
|||
| def _extractExceptionsFromExcept( | |||
| node: ast.ExceptHandler, | |||
| ) -> Generator[str, None, None]: | |||
| ) -> Iterator[str]: | |||
There was a problem hiding this comment.
Iterator[str] is sort of a shorthand for Generator[str, None, None]. (And in Python 3.14, Generator[str] is finally recognized as a shorthand for Generator[str, None, None].)
But to be consistent with existing functions in this file, I'll revert back to using Generator[str, None, None].
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Should the language of DOC5* be modified to include assert? Should it be a new DOC rule?
Closes #213.