python文档字符串样式检查器
pydocstyle的Python项目详细描述
pydocstyle是一个静态分析工具,用于检查是否符合python 文档字符串约定。
pydocstyle支持 PEP 257开箱即用,但是 不应视为参考实现。
pydocstyle支持python 3.4、3.5、3.6和3.7。
快速启动
安装
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) ...