Pydoclint

Latest version: v0.5.10

Safety actively analyzes 688600 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 5 of 10

0.3.0

- Improved
- Relaxed Generator/Iterator checking: stop enforcing the return annotation
to be Generator if a function yields something
(https://github.com/jsh9/pydoclint/issues/76)
- Added handling of functions that both return something and yield something
- Changed
- Used docstring_parser_fork to parse numpy-style docstrings, because the
official numpydoc doesn't support both Yields and Returns sections in a
single docstring
- Removed
- Dependency on numpydoc
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.2.4...0.3.0

0.2.4

- Fixed
- A bug with unparsing yield types
(https://github.com/jsh9/pydoclint/issues/75#issuecomment-1691398673)
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.2.3...0.2.4

0.2.3

- Fixed
- A bug with yields type checking
- A typo in `DOC403` code logic
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.2.2...0.2.3

0.2.2

- Improved

- Improved handling of escape symbol (`\`) in docstrings
(https://github.com/jsh9/pydoclint/issues/73)

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.2.1...0.2.2

0.2.1

- Improved

- Improved handling of backticks or double backticks being used in type hints
in docstrings

- Full diff
- https://github.com/jsh9/pydoclint/compare/0.2.0...0.2.1

0.2.0

- Added
- Added checking of yield types (between function signature and the
docstring's Yields section), as well as a corresponding violation: `DOC404`
- Added checking of incompatibility between `Generator`/`Iterator` and the
`yield`/`return` statements, as well as a corresponding violation: `DOC405`
(https://github.com/jsh9/pydoclint/issues/68)
- Fixed
- Fixed a bug where raise/return/yield statements in match-case blocks are
incorrectly identified. (https://github.com/jsh9/pydoclint/issues/63)
- Improved
- Used a try/catch block to capture potential recursion error, potentially
due to too complex functions/classes
(https://github.com/jsh9/pydoclint/issues/65)
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.1.9...0.2.0

Page 5 of 10

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.