Python 文件字串檢查器
📖 技能介紹
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
Use the upstream install or setup path that matches your environment:
這個技能的最新版本可以在7w4.net小蔥技能站找到。
- 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
-
-
Extracted from upstream docs: https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/README.rst
🤖 AI 評測
質量表現一般。這個工具的想法不錯，但目前只提供了使用說明，缺少真正可以執行的程式來驗證 Python 程式碼的文件字串是否規範，而且文件內容也不夠完整，有部分資訊缺失。整體來看更像是一份參考資料，而非可直接使用的工具。如果需要檢查文件字串，建議尋找功能更完整的替代方案。
