https://github.com/PyCQA/pydocstyle

docstring style checker
https://github.com/PyCQA/pydocstyle

docstrings linter python

Last synced: about 1 month ago
JSON representation

docstring style checker

• Host: GitHub
• URL: https://github.com/PyCQA/pydocstyle
• Owner: PyCQA
• License: mit
• Archived: true
• Created: 2012-01-31T17:18:23.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2023-11-03T22:28:46.000Z (about 1 year ago)
• Last Synced: 2024-10-29T23:50:33.707Z (about 1 month ago)
• Topics: docstrings, linter, python
• Language: Python
• Homepage: http://pydocstyle.org
• Size: 988 KB
• Stars: 1,109
• Watchers: 19
• Forks: 189
• Open Issues: 124
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE-MIT

Awesome Lists containing this project

• awesome-robotic-tooling - pydocstyle - A static analysis tool for checking compliance with Python docstring conventions. (Development Environment / Lint and Format)
• awesome-robotic-tooling - pydocstyle - pydocstyle is a static analysis tool for checking compliance with Python docstring conventions (Development Environment / Lint and Format)
• awesome-python-ast - pydocstyle - docstring style checker (Linters)
• best-of-python-dev - GitHub - 35% open · ⏱️ 03.11.2023): (Linters & Style Checkers)

README

        
pydocstyle - docstring style checker

====================================

======================================

Deprecation Notice: Pydocstyle

======================================

.. IMPORTANT: Deprecation Notice

   :style: alert

.. image:: https://img.shields.io/badge/deprecated-red

   :target: https://github.com/PyCQA/pydocstyle

   :alt: Deprecated

The Pydocstyle project is officially deprecated, and it is no longer actively maintained. 

Ruff: A Modern Alternative

--------------------------

- **GitHub Repository:** `ruff `_

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 users to switch over to ruff for a seamless transition.

A Heartfelt Thank You

-----------------------

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 time and effort you've invested in making pydocstyle a valuable tool for the Python community.

Thank you for your support of pydocstyle in the past.

---------

.. image:: https://github.com/PyCQA/pydocstyle/workflows/Run%20tests/badge.svg

    :target: https://github.com/PyCQA/pydocstyle/actions?query=workflow%3A%22Run+tests%22+branch%3Amaster

.. image:: https://readthedocs.org/projects/pydocstyle/badge/?version=latest

    :target: https://readthedocs.org/projects/pydocstyle/?badge=latest

    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/pyversions/pydocstyle.svg

    :target: https://pypi.org/project/pydocstyle

.. image:: https://pepy.tech/badge/pydocstyle

    :target: https://pepy.tech/project/pydocstyle

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336

    :target: https://pycqa.github.io/isort/

.. image:: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod

    :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle

    :alt: Gitpod ready-to-code

**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.

**pydocstyle** supports Python 3.6+.

Quick Start

-----------

Install

^^^^^^^

.. code::

    pip install pydocstyle

Run

^^^

.. code::

    $ pydocstyle test.py

    test.py:18 in private nested class `meta`:

            D101: Docstring missing

    test.py:27 in public function `get_user`:

        D300: Use """triple double quotes""" (found '''-quotes)

    test:75 in public function `init_database`:

        D201: No blank lines allowed before function docstring (found 1)

    ...

Develop

^^^^^^^

You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -

.. image:: https://gitpod.io/button/open-in-gitpod.svg

    :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle

    :alt: Open in Gitpod

    

Before submitting a PR make sure that you run `make all`.

Links

-----

* `Read the full documentation here `_.

* `Fork pydocstyle on GitHub `_.

* `PyPI project page `_.