agentskillexchange Python Docstring Linter
Validates and auto-generates Python docstrings using the ast module and pydocstyle conventions. Supports NumPy, Google, and Sphinx docstring formats with type stub integration.
Installation
Use the upstream install or setup path that matches your environment:
- pip install pydocstyle
- Before submitting a PR make sure that you run make all.
Requirements and caveats from upstream:
- Ruff offers full parity with pydocstyle along with advanced features, better support for the latest Python versions, and ongoing development to ensure a top-notch linting experience. We highly recommend pydocstyle use...
- pydocstyle is a static analysis tool for checking compliance with Python
- PEP 257 http://www.python.org/dev/peps/pep-0257/_ out of the box, but it
Basic usage or getting-started notes:
- We want to express our heartfelt gratitude to the pydocstyle community, maintainers, and contributors for their support and dedication over the years. Your contributions have been invaluable, and we appreciate the tim...
- .. image:: https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg
- Source: https://github.com/PyCQA/pydocstyle
- Extracted from upstream docs: https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/README.rst