CHANGELOG.md

Unreleased

...

2.3.2 (2024-05-07)

Changes

• Unpin TQDM version requirement. #142 by MiWeiss.

2.3.1 (2024-02-28)

Features

• Add support for Python 3.12. #139 by MiWeiss.

Deprecations

• Remove support for Python 3.7. #139 by MiWeiss.

2.3.0 (2023-04-13)

Features

• Display progress bar during docstring analysis. #106 by MiWeiss.
• Add support for analyzing async functions' docstrings. #116 by caffeinatedMike.
• Add support for Python 3.11. #117 by MiWeiss.

Deprecations

• Remove support for Python 3.6. #117 by MiWeiss.
• Deprecate --docstr-ignore-file flag. #87 by MiWeiss.
  • Going forward, please use the ignore_patterns option in your config file
  • The --docstr-ignore-file will be removed in a future release

2.2.0 (2022-03-17)

Features

• Add --skip-property flag to ignore methods with the @property decorator. #86 by MiWeiss.
• Add --include-setter flag to check methods with the @setter decorator. #86 by MiWeiss.
• Add --include-deleter flag to check methods with the @deleter decorator. #86 by MiWeiss.

2.1.1 (2021-07-02)

Bug Fixes

• Fix inconsistent pre-commit hook behavior. #84 by killthekitten.
  • This was caused by the hook being run on different sets of files
  • If you are experiencing issues with the pre-commit hook, please ensure that you have properly set the paths argument in your config file

Changes

• Don't report on fully-documented files by default. #85 by MiWeiss.
  • The new verbosity level of 4 will include fully-documented files in the report

2.1.0 (2021-06-25)

Features

• Add pre-commit hook. #78 by bjornconstructors
• Experimental: Expose new analyze method, which returns fine-grained coverage reports. #67 by MiWeiss

Bug Fixes

• Remove a false AssertionError which was raised for long docstrings. #82 by MiWeiss

2.0.1 (2021-03-03)

Bug Fixes

• Fix --help/-h flag. #57 by MiWeiss.

2.0.0 (2021-01-11)

Features

• Add .docstr.yaml config file. #39 by mBouamama.
  • Save docstr-coverage CLI options in .docstr.yaml to be used as the default configuration
  • For more details, see the README's "Config File" section
• Allow ignore_patterns to be defined in the .docstr.yaml config file. #46 by MiWeiss.
  • This is an alternative to the --docstr-ignore-file CLI option. Do not use both at the same time
• Add --accept-empty/-a flag to exit with code 0 if no .py files are found. #48 by MiWeiss.
  • Helpful for using docstr_coverage in GitHub Actions as described in #47 by epassaro

Deprecations

• Convert all CLI options to kebab-case. #38 by cthoyt.

  New	Deprecated
  --fail-under	--failunder
  --follow-links	--followlinks
  --skip-class-def	--skipclassdef
  --skip-file-doc	--skipfiledoc
  --skip-init	--skipinit
  --skip-magic	--skipmagic

  • ❗ Deprecated option names will be removed in v3.0.0 ❗

Bug Fixes

• Fix Windows compatibility issues and upgrade CI suite. #45 by MiWeiss.

1.4.0 (2020-12-05)

Features

• Excuse missing docstrings by marking classes/functions with special comments. #34 by MiWeiss.
  • # docstr_coverage: inherited to mark subclass methods as being documented by their parent
  • # docstr_coverage: excused `My bad excuse` to arbitrarily excuse missing docstrings
  • Find examples and more information here

1.3.0 (2020-11-17)

Features

• Add ability to skip private functions. #32 by cthoyt.

1.2.0 (2020-07-21)

Features

• Added ability to pass multiple paths to CLI for docstring inspection. #24 by HunterMcGushion.
• Added --badge/-b option to generate a docstring coverage percent badge as an SVG image saved to a given filepath. #22 by HunterMcGushion.

Bug Fixes

• Fixed bug where a total coverage of 0 would break everything. #16 by killthekitten.
• Fixed bug where the -d/--docstr-ignore-file CLI option to provide an ignore_names_file would not work with -v 3/--verbose=3. #19 by HunterMcGushion.

Changes

• Added testing safety net. #16 by killthekitten.

1.1.0 (2020-05-20)

Features

• Added --failunder/-F option to fail if coverage is below a given percentage. #11 by econchick.
  • Default=100.0

1.0.5 (2019-11-18)

Features

• Added --docstr-ignore-file/-d option to provide a file, containing a list of patterns to ignore during coverage calculation. #4 by Redysz.
• Added support for raising the exit code to be used with CI pipelines. #6 by sim0nx.

1.0.4 (2019-04-17)

Features

• Added support for non-ASCII characters. #3 by Redysz.

1.0.3 (2019-01-28)

Bug Fixes

• Fixed bug preventing docstr-coverage from being properly installed via tox. #2 by asergeant01.

0.1.0 (2018-08-01)

Features

• Initial release