Skip to content

Releases: jsh9/pydoclint

0.5.9

29 Sep 22:31
8170436
Compare
Choose a tag to compare

What's Changed

  • doc(usage): Including a null-ls use with neovim. by @aemonge in #167
  • Improve handling of long type annotations by @jsh9 in #173

New Contributors

Full Changelog: 0.5.8...0.5.9

0.5.8

23 Sep 07:52
5e941f5
Compare
Choose a tag to compare

What's Changed

Full Changelog: 0.5.7...0.5.8

0.5.7

03 Sep 00:40
f758604
Compare
Choose a tag to compare

What's Changed

  • docs: add "sphinx" as an allowed style by @Amar1729 in #159
  • tox: use deps = . instead of pip install by @Amar1729 in #160
  • Switch from tab to 4 spaces in baseline by @cidrblock in #152
  • feat: introduce DOC503 for checking specific raised exceptions by @Amar1729 in #161

New Contributors

Full Changelog: 0.5.6...0.5.7

0.5.6

17 Jul 08:39
94efc5f
Compare
Choose a tag to compare

What's Changed

  • Stop trying to check folder with names ending in .py by @jsh9 in #155

Full Changelog: 0.5.5...0.5.6

0.5.5

16 Jul 09:17
0247ef5
Compare
Choose a tag to compare

What's Changed

  • Improve class attr comparison logic by @jsh9 in #154

Full Changelog: 0.5.4...0.5.5

0.5.4

14 Jul 17:51
0b750d5
Compare
Choose a tag to compare

What's Changed

  • Add an option for private class attributes by @jsh9 in #149
  • Add option to treat property methods as class attributes by @jsh9 in #153

Full Changelog: 0.5.3...0.5.4

0.5.3

27 Jun 02:36
98f7a5c
Compare
Choose a tag to compare

What's Changed

  • Add DOC604 & 605 test cases; improve DOC605 err msg by @jsh9 in #147

Full Changelog: 0.5.2...0.5.3

0.5.2

27 Jun 01:44
4d0293a
Compare
Choose a tag to compare

What's Changed

  • Make url a proper link by @Gabriel-p in #137
  • Don't report DOC6xx if no docstring or short docstring by @jsh9 in #145
  • Don't report DOC109 if arg list is empty by @jsh9 in #146
  • Updated some documentations (1a270b0)

New Contributors

Full Changelog: 0.5.1...0.5.2

0.5.1

24 Jun 08:48
f43a961
Compare
Choose a tag to compare

What's Changed

  • Fix annotation unparsing bug by @jsh9 in #132
  • Fix another bug in class attr checking by @jsh9 in #133
  • Use "attribute" docstring section in Sphinx style by @jsh9 in #136

Full Changelog: 0.5.0...0.5.1

0.5.0

23 Jun 04:12
1e1c88f
Compare
Choose a tag to compare

What's Changed

  • Check class attributes against docstring by @jsh9 in #130
    • This functionality checks class attributes against the "Attributes"
      section of the docstring
    • There is a new config option, --check-class-attributes (or -cca),
      which defaults to True. Therefore, this breaks backward compatibility.
    • To maintain backward compatibility, set --check-class-attributes to
      False
    • Options like --check-arg-order, --arg-type-hints-in-signature, and
      --arg-type-hints-in-docstring are still effective in checking class
      attributes

Full Changelog: 0.4.2...0.5.0