Skip to content

Latest commit

 

History

History
407 lines (299 loc) · 11.7 KB

CHANGELOG.md

File metadata and controls

407 lines (299 loc) · 11.7 KB
Raw

Change Log

[0.3.9] - 2024-01-16

[0.3.8] - 2023-10-20

[0.3.7] - 2023-10-19

[0.3.6] - 2023-10-18

[0.3.5] - 2023-10-17

[0.3.4] - 2023-10-12

[0.3.3] - 2023-10-01

  • Added

    • Added baseline file integration and 2 options:
      1. --generate-baseline True Generate baseline content, and write it to a file specified from --baseline option path.
      2. --baseline <PATH> Specify path to file with baseline content.

  • Changed

    • For the --config option, the default value is now pyproject.toml.

  • Full diff

[0.3.2] - 2023-09-04

[0.3.1] - 2023-08-28

[0.3.0] - 2023-08-26

  • Improved
    • Relaxed Generator/Iterator checking: stop enforcing the return annotation to be Generator if a function yields something (jsh9#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

[0.2.4] - 2023-08-24

[0.2.3] - 2023-08-24

[0.2.2] - 2023-08-22

[0.2.1] - 2023-08-21

[0.2.0] - 2023-08-18

  • 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 (jsh9#68)
  • Fixed
    • Fixed a bug where raise/return/yield statements in match-case blocks are incorrectly identified. (jsh9#63)
  • Improved
    • Used a try/catch block to capture potential recursion error, potentially due to too complex functions/classes (jsh9#65)
  • Full diff

[0.1.9] - 2023-08-18

[0.1.8] - 2023-08-16

[0.1.7] - 2023-08-15

[0.1.6] - 2023-08-13

[0.1.5] - 2023-08-12

[0.1.4] - 2023-07-23

[0.1.3] - 2023-07-21

[0.1.2] - 2023-07-20

[0.1.1] - 2023-07-18

[0.1.0] - 2023-07-15

[0.0.16] - 2023-07-14

[0.0.15] - 2023-07-10

[0.0.14] - 2023-07-05

[0.0.13] - 2023-06-26

[0.0.12] - 2023-06-26

[0.0.11] - 2023-06-26

[0.0.10] - 2023-06-12

[0.0.9] - 2023-06-12

[0.0.8] - 2023-06-06

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

[0.0.7] - 2023-06-01

[0.0.6] - 2023-05-31

[0.0.5] - 2023-05-31

  • Added
    • A new option to allow no return section in the docstring if the function implicitly returns None (jsh9#6)
  • Changed
    • Made pydoclint options configurable via a config file (both in the native mode and in the flake8 plugin mode) (jsh9#11)
    • Methods with @property as its last decorator no longer need to have a return section in the docstring (jsh9#13)
  • Full diff

[0.0.4] - 2023-05-27

  • Added
    • A new violation, DOC001, for errors in parsing docstrings (jsh9#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) (jsh9#7)
  • Changed
    • Used AST unparser to unparse type annotation nodes
  • Fixed
    • A bug when parsing type annotations such as Callable[[int], str]
  • Full diff

[0.0.3] - 2023-05-18

[0.0.2] - 2023-05-16

[0.0.1] - 2023-05-15

Initial release