python docstring structuredtext(rst)验证程序
flake8-rst-docstrings的Python项目详细描述
简介
这是麻省理工学院授权的flake8插件,用于验证python docstrings标记 使用python库重构文本(rst)。它是 可从python包索引(pypi)安装:
这是基于pydocstyle(它也是mit授权的),它 有一个名为flake8 docstrings的flake8插件,请参见:
通过调用 Todd Wolfson的"重构文本lint"代码:
我建议您也安装相关的flake8 docstrings插件 PyDocStyle将签入flake8。 这将检查诸如缺少docstring和其他来自 pep 257文档字符串约定
您可能还希望安装相关的flake8插件,该插件可以检查python样式。 您的 *.rst 文件中的doctest格式的python代码片段 或文件中的docstrings。