flake8的扩展，它使用pydocstyle检查docstring
flake8-docstrings的Python项目详细描述
flake8文档字符串
为奇妙的pydocstyle工具添加扩展的简单模块 flake8。
只需安装此扩展：
pip install flake8-docstrings
然后运行flake8。
您可以在命令行使用：
$ flake8 --docstring-convention numpy ...
或者，将docstring-convention=numpy添加到flake8配置文件中。 可用的约定集取决于安装的PydocStyle的版本。 默认值是pep257，pydocstyle v2.0.0添加了numpy（对于numpydoc 标准），而pydocstyle v4.0.0添加了google。
在我们的bug tracker上报告任何问题。
历史记录/更改日志
1.4.0
- 添加允许选择约定的--docstring-convention选项 除了默认的pep257。可用选项基于 可从pydocstyle获得，当前为pep257，google，以及 numpy。flake8-docstrings还添加了一个特殊的alldocstring 将启用来自pydocstyle的所有规则的约定。请注意 pydocstyle定义了一些冲突的规则，因此您需要使用 ignore/extend-ignore选择docstring-convention = all
- 将最小薄片8版本提高到3
- 修复通过--stdin-display-name 正确处理stdin的问题
1.3.1
- 修复与PydocStyle 4.x的不兼容性
1.3.0
- 将PydocStyle的最低版本提高到2.1.0
1.2.0
- 修复environerror和allerror调用
- 避免flake8请求builtins
1.1.0
- 将对PydocStyle的依赖性升级到2.0.0
1.0.3
- 使用flake8 polyfill获取标准输入，以处理flake8 3.x和2.x
1.0.2
- 使用pycodestyle获取标准。
1.0.1
- 使用Flake8 3.0时，请确保这是现成的（默认情况下已启用）
1.0.0
- 将依赖项名称切换为PydocStyle。pep257被重命名为pydocstyle，这个 更新将要求切换到新的包名称。既然我们 换掉依赖项，我们发布了一个主要版本的bump。
0.2.7
- 尝试将PydocStyle（而不是PydocStyle）导入为PEP257
0.2.6
- 尊重PEP257的默认忽略列表
- 处理PEP257中的allerror和其他异常
0.2.5
- 使用pep257的tokenize_open函数将输入传递给工具。
- 使用PEP257的约定，以便默认忽略任何错误代码 默认情况下，使用pep257的插件也会被忽略。
0.2.4
- 修复0.2.2中引入的错误，其中文件源始终不是导致 所有文件的D100和D104错误，未发现其他错误。
0.2.3
- 删除错误消息中的多余空格。
- 用flake8 --version修复插件的显示方式。
0.2.2
- 更好地支持通过stdin提供的输入。
0.2.1
- 防止引发allerror或environmenterrors。谢谢亚历克斯 皮疹。
0.2.0
- 升级至pep257 0.3.0
0.1.4
- 停止截断错误消息
0.1.3
- 这次真的解决了安装问题。
0.1.2
- 实际上修复了pypi版本。ugh
0.1.1
- 修复pypi版本。
0.1.0
- 初次发布！
欢迎加入QQ群-->： 979659372
