./devel/py-docstyle, Python docstring style checker

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: CURRENT, Version: 6.3.0, Package name: py310-docstyle-6.3.0, Maintainer: pkgsrc-users

pydocstyle is a static analysis tool for checking compliance with
Python docstring conventions.

pydocstyle supports most of PEP 257 out of the box, but it should
not be considered a reference implementation.


Required to run:
[devel/py-setuptools] [lang/python27] [lang/py-six] [textproc/py-snowballstemmer] [devel/py-configparser]

Required to build:
[pkgtools/cwrappers]

Master sites:

Filesize: 35.934 KB

Version history: (Expand)


CVS history: (Expand)


   2023-07-30 17:32:50 by Adam Ciarcinski | Files touched by this commit (19)
Log message:
Remove dependencies for Python 3.7
   2023-04-30 17:23:08 by Thomas Klausner | Files touched by this commit (3) | Package updated
Log message:
py-docstyle: update to 6.3.0.

6.3.0

What's Changed

    Fix typo in pre-commit-hook by @samj1912 in #624
    Add ignore-self-only-init option by @thejcannon in #560

6.2.3

What's Changed

    Fix decorator parsing for async functions by @cdce8p in #577
    fix: do not pass file names with pre-commit by @yajo in #610

6.2.2

What's Changed

    Fix false positive of google convention missing args descriptions by \ 
@stinovlas in #619

6.2.1

What's Changed

    Add https protocol on websites at the README.rst by @realFranco in #611
    Add Python 3.11 to the testing by @cclauss in #612
    requirements/docs.txt: Use current versions of Jinja2 and sphinx by @cclauss \ 
in #615
    Use tomllib/tomli for reading .toml configs by @mgorny in #608
    Docs: pydocstyle supports Python 3.7 through 3.11. by @cclauss in #616

6.2.0

What's Changed

    Gitpod-ify the repository by @samj1912 in #548
    Updating readme to reflect support for Python 3.9 by @sanders41 in #545
    Exempt properties from D401 by @TomFryers in #546
    Add support for Python 3.10 by @hugovk in #554
    Fix CI for python 3.10 by @samj1912 in #565
    Add D419: Add and switch to "Docstring is empty" error code by \ 
@thejcannon in #559
    Allow for hanging indent when documenting args in Google style by @rmorshea \ 
in #564
    Fix match option to only consider basename when given a path argument by \ 
@oczkoisse in #550
    Typo fix in docs/error_codes.rst by @Daniel-Mietchen in #578
    docs: Fix double-dash converted to en-dash by @wjandrea in #579
    Fix test warnings and improve lint configuration by @aphedges in #584
    Fix broken CI checks by @aphedges in #585
    Move tool configs to pyproject.toml by @Mr-Pepe in #588
    Add github action to be able to release on published tag by \ 
@Pierre-Sassoulas in #582
    Typo by @Fokko in #598
    Move to poetry and automated relases via Github UI by @samj1912 in #614
   2022-06-19 00:06:28 by Thomas Klausner | Files touched by this commit (3) | Package updated
Log message:
py-docstyle: update to 6.1.1.

6.1.1 - May 17th, 2021

Bug Fixes

    Split --source by lines instead of by characters (#536).

6.1.0 - May 17th, 2021

New Features

    Enable full toml configuration and pyproject.toml (#534).

6.0.0 - March 18th, 2021

Major Updates

    Support for Python 3.5 has been dropped (#510).

New Features

    Add flag to disable # noqa comment processing in API (#485).
    Methods, Functions and Nested functions that have a docstring
    now throw D418 (#511).
    Methods decorated with @overload no longer reported as D102
    (#511).
    Functions and nested functions decorated with @overload no
    longer reported as D103 (#511).

Bug Fixes

    Treat “package” as an imperative verb for D401 (#356).
    Fix the parsing of decorated one line functions (#499).

5.1.2 - September 13th, 2020

New Features

    Methods, Functions and Nested functions that have a docstring
    now throw D418 (#511).
    Methods decorated with @overload no longer reported as D102.
    Functions and nested functions decorated with @overload no
    longer reported as D103.

5.1.1 - August 29th, 2020

Bug Fixes

    Fix IndexError crash on one-line backslashed docstrings (#506).

5.1.0 - August 22nd, 2020

New Features

    Skip function arguments prefixed with _ in D417 check (#440).

Bug Fixes

    Update convention support documentation (#386, #393)
    Detect inner asynchronous functions for D202 (#467)
    Fix indentation error while parsing class methods (#441).
    Fix a bug in parsing Google-style argument description. The
    bug caused some argument names to go unreported in D417 (#448).
    Fixed an issue where skipping errors on module level docstring
    via #noqa failed when there where more prior comments (#446).
    Support backslash-continued descriptions in docstrings (#472).
    Correctly detect publicity of modules inside directories (#470,
    #494).

5.0.2 - January 8th, 2020

Bug Fixes

    Fix DeprecationWarning / SyntaxError “invalid escape sequence”
    with Python 3.6+ (#445).

5.0.1 - December 9th, 2019

Bug Fixes

    Fixed an issue where AttributeError was raised when parsing
    the parameter section of a class docstring (#434, #436).

5.0.0 - December 9th, 2019

Major Updates

    Support for Python 3.4 has been dropped (#402).

New Features

    Extend support for detecting missing arguments in Google style
    docstrings to method calls (#384).
    Extend support for detecting missing argument description in
    Numpy style docstrings (#407).
    Added support for Python 3.8 (#423).
    Allow skipping errors on module level docstring via #noqa
    (#427).
    Whitespace is ignored with set options split across multiple lines (#221).

Bug Fixes

    Remove D413 from the google convention (#430).
    Remove D413 from the pep257 convention (#404).
    Replace semicolon with colon in D416 messages. (#409)
    D301 (Use r””” if any backslashes in a docstring) does not
    trigger on backslashes for line continuation or unicode literals
    \u... and \N... anymore. These are considered intended elements
    of the docstring and thus should not be escaped by using a raw
    docstring (#365).
    Fix decorator parsing (#411).
    Google-style sections no longer cause false errors when used
    with Numpy-style sections (#388, #424).
    D202: Allow a blank line after function docstring when followed
    by declaration of an inner function or class (#395, #426).
    Fix D401 and D404 checks not working for docstrings containing
    only one word and ending with non-alpha character (#421)

4.0.1 - August 14th, 2019

Bug Fixes

    D401: Fixed a false positive where one stem had multiple
    imperative forms, e.g., init and initialize / initiate (#382).
    Fix parser hanging when there’s a comment directly after __all__
    (#391, #366).
    Fixed RST error in table which resulted in the online documentation
    missing the violation code table (#396).
    Fixed IndentationError when parsing function arguments (#392).

4.0.0 - July 6th, 2019

Major Updates

    Support for Python 2.x and PyPy has been dropped (#340).
    Added initial support for Google convention (#357).

New Features

    Added pre-commit hook (#346)

Bug Fixes

    Fix parsing tuple syntax __all__ (#355, #352).
   2022-01-05 16:41:32 by Thomas Klausner | Files touched by this commit (289)
Log message:
python: egg.mk: add USE_PKG_RESOURCES flag

This flag should be set for packages that import pkg_resources
and thus need setuptools after the build step.

Set this flag for packages that need it and bump PKGREVISION.
   2022-01-04 21:55:40 by Thomas Klausner | Files touched by this commit (1595)
Log message:
*: bump PKGREVISION for egg.mk users

They now have a tool dependency on py-setuptools instead of a DEPENDS
   2021-10-26 12:20:11 by Nia Alarie | Files touched by this commit (3016)
Log message:
archivers: Replace RMD160 checksums with BLAKE2s checksums

All checksums have been double-checked against existing RMD160 and
SHA512 hashes

Could not be committed due to merge conflict:
devel/py-traitlets/distinfo

The following distfiles were unfetchable (note: some may be only fetched
conditionally):

./devel/pvs/distinfo pvs-3.2-solaris.tgz
./devel/eclipse/distinfo eclipse-sourceBuild-srcIncluded-3.0.1.zip
   2021-10-07 15:44:44 by Nia Alarie | Files touched by this commit (3017)
Log message:
devel: Remove SHA1 hashes for distfiles
   2018-12-05 16:52:42 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-docstyle: updated to 3.0.0

3.0.0:

Major Updates
Support for Python 3.3 has been dropped
Added support for Python 3.7

New features
Violations are now reported on the line where the docstring starts, not the line \ 
of the def/class
Updated description of pep257 and numpy conventions
__all__ parsing is now done on a best-effort basis - if __all__ can't be \ 
statically determined, it will be ignored

Bug Fixes
Fixed a false-positive recognition of section names causing D405 to be reported
Fixed a bug where functions that don't end with a newline will sometimes raise \ 
an exception