Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

PyCQA/pydocstyle

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

Over the last couple of years, I have been the sole maintainer of pydocstyle. During the last year, we made a call for maintainers but we're unsuccessful in finding appropriate maintainers. Given the emergence of ruff and it's features, it's hard to justify the continued maintenance of pydocstyle. After a conversation with @Nurdok we both agree it's time to archive the project in favor of ruff.
8d0cdfc

Git stats

Files

Permalink
Failed to load latest commit information.

pydocstyle - docstring style checker

Deprecation Notice: Pydocstyle

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.


Documentation Status https://pepy.tech/badge/pydocstyle https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 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

pip install pydocstyle

Run

$ 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 -

Open in Gitpod

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

Links