跳转到主要内容

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 功能来选择您想要检查的代码。

错误跟踪器上报告任何问题。

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪一个,请了解有关安装包的更多信息。

源分布

flake8_docstrings-1.7.0.tar.gz (6.0 kB 查看散列)

上传时间

构建分布

flake8_docstrings-1.7.0-py2.py3-none-any.whl (5.0 kB 查看散列)

上传时间 Python 2 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面