pydocstyle - 文档字符串风格检查器

====================================== 弃用通知：Pydocstyle

.. 重要：弃用通知 :style: alert

.. image:: https://img.shields.io/badge/deprecated-red :target: https://github.com/PyCQA/pydocstyle :alt: 已弃用

Pydocstyle 项目正式弃用，不再积极维护。

Ruff：现代化替代方案

GitHub 仓库： ruff <https://github.com/astral-sh/ruff>_

Ruff 提供了与 pydocstyle 完全相同的功能，同时具有高级特性、对最新 Python 版本的更好支持，以及持续开发以确保顶级的代码检查体验。我们强烈建议 pydocstyle 用户切换到 ruff，以实现无缝过渡。

衷心感谢

我们想向 pydocstyle 社区、维护者和贡献者表达衷心的感谢，感谢他们多年来的支持和奉献。你们的贡献非常宝贵，我们感谢你们为使 pydocstyle 成为 Python 社区的有价值工具所投入的时间和精力。

感谢你们过去对 pydocstyle 的支持。

.. 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: 文档状态

.. 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 是一个静态分析工具，用于检查 Python 文档字符串是否符合约定。

pydocstyle 默认支持大部分 PEP 257 <http://www.python.org/dev/peps/pep-0257/>_ 规范，但不应被视为参考实现。

pydocstyle 支持 Python 3.6+。

快速入门

安装 ^^^^^^^

.. code::

pip install pydocstyle

运行 ^^^

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

开发 ^^^^^^^

你可以使用 Gitpod 在云端运行预配置的开发环境，直接从浏览器访问 -

.. image:: https://gitpod.io/button/open-in-gitpod.svg :target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle :alt: 在 Gitpod 中打开

在提交 PR 之前，请确保运行 make all。