Python 文档字符串样式检查器
项目描述
pydocstyle 是一个用于检查Python文档字符串约定的静态分析工具。
pydocstyle 默认支持PEP 257的大部分内容,但不应该被视为参考实现。
pydocstyle 支持 Python 3.6+。
快速入门
安装
pip install pydocstyle
运行
$ 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在浏览器中直接运行预配置的云开发环境-
在提交PR之前,请确保运行make all。
链接
项目详情
下载文件
下载适合您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分发
pydocstyle-6.3.0.tar.gz (36.8 kB 查看哈希值)
构建分发
pydocstyle-6.3.0-py3-none-any.whl (38.0 kB 查看哈希值)