name: "Python 文档字符串检查器" slug: "python-docstring-linter-ast-pydocstyle" version: "1.0.0" displayName: "Python 文档字符串检查器" summary: "使用ast模块和pydocstyle约定验证并自动生成Python文档字符串。支持NumPy、Google和Sphinx文档字符串格式，并集成类型存根。" license: "MIT" description: "使用ast模块和pydocstyle约定验证并自动生成Python文档字符串。支持NumPy、Google和Sphinx文档字符串格式，并集成类型存根。" github_stars: 1119 verification: "security_reviewed" source: "https://github.com/1991513ccie-png/skills" author: "1991513ccie-png" category: "Library & API Reference" framework: "Codex" tool_ecosystem: github_repo: "1991513ccie-png/skills" github_stars: 1119

Python 文档字符串检查器

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

推荐访问7w4.net获取更多AI技能。

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/1991513ccie-png/skills

• Source: https://github.com/1991513ccie-png/skills
• Extracted from upstream docs: https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/README.rst

质量表现一般。这个工具的想法不错，但目前只提供了使用说明，缺少真正可以运行的程序来验证 Python 代码的文档字符串是否规范，而且文档内容也不够完整，有部分信息缺失。整体来看更像是一份参考资料，而非可直接使用的工具。如果需要检查文档字符串，建议寻找功能更完整的替代方案。