Pydoclint

Latest version: v0.5.10

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

Scan your dependencies

Page 9 of 10

0.0.8

- Added
- A command line option `--version` to show the current version of pydoclint
(https://github.com/jsh9/pydoclint/pull/17)
- Enabled pydoclint to be used as a pre-commit hook
(https://github.com/jsh9/pydoclint/pull/18)
- Fixed
- Encoding issues in Windows (where non-ASCII characters cause issues with
Windows + pre-commit) (https://github.com/jsh9/pydoclint/pull/21)
- Stopped using colons (:) in flake8 error messages because they could cause
issues with tools like "yesqa" (https://github.com/jsh9/pydoclint/pull/22)
- Changed
- Expanded the logic to identify generator functions
(https://github.com/jsh9/pydoclint/issues/15)
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.0.7...0.0.8

0.0.7

- Fixed
- Fixed a bug where re-raising an exception was not handled properly
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.0.6...0.0.7

0.0.6

- Fixed
- A typo in `DOC103` error message that resulted in an invalid URL
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.0.5...0.0.6

0.0.5

- Added
- A new option to allow no return section in the docstring if the function
implicitly returns `None` (https://github.com/jsh9/pydoclint/issues/6)
- Changed
- Made pydoclint options configurable via a config file (both in the native
mode and in the flake8 plugin mode)
(https://github.com/jsh9/pydoclint/pull/11)
- Methods with `property` as its last decorator no longer need to have a
return section in the docstring (https://github.com/jsh9/pydoclint/pull/13)
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.0.4...0.0.5

0.0.4

- Added
- A new violation, `DOC001`, for errors in parsing docstrings
(https://github.com/jsh9/pydoclint/pull/8)
- A new option to allow `__init__()` methods to have docstring (and when
users activate this option, check arguments and "Raises" in the docstring
of `__init__()` instead of in the class docstring)
(https://github.com/jsh9/pydoclint/pull/7)
- Changed
- Used AST unparser to unparse type annotation nodes
- Fixed
- A bug when parsing type annotations such as `Callable[[int], str]`
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.0.3...0.0.4

0.0.3

- Added
- Added support for
[Google-style docstrings](https://google.github.io/styleguide/pyguide.html#s3.8.1-comments-in-doc-strings)
- Full diff
- https://github.com/jsh9/pydoclint/compare/0.0.2...0.0.3

Page 9 of 10

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.