flake8扩展,使用pydocstyle检查文档字符串
项目描述
一个简单的模块,它为出色的pydocstyle工具添加了一个扩展,用于flake8。
只需安装此扩展
pip install flake8-docstrings
然后运行flake8。
您可以使用以下命令在命令行中设置pydocstyle 约定
$ flake8 --docstring-convention numpy ...
或者,将docstring-convention=numpy添加到您的flake8配置文件中。可用的约定集合取决于已安装的pydocstyle版本。默认为pep257,pydocstyle v2.0.0添加了numpy(用于numpydoc标准),而pydocstyle v4.0.0添加了google。
为了选择自定义的错误代码列表,请使用特殊值 docstring-convention=all,然后使用 flake8 的内置 --ignore/--select 功能来选择您想要检查的代码。
在错误跟踪器上报告任何问题。