【文件属性】:
文件名称:darglint:python文档检查器,用于检查docstring描述是否与定义匹配
文件大小:542KB
文件格式:ZIP
更新时间:2021-05-14 12:43:31
linter documentation-tool Python
达格利特
一个功能齐全的文档字符串查询器,用于检查文档字符串的描述是否与实际的函数/方法实现相匹配。 Darglint期望使用, 或来格式化文档字符串。
如果发现问题或想要使用darglint中的功能,请随时提交问题/拉取请求。
目录:
安装
要安装darglint ,请使用pip。
pip install darglint
或者,克隆存储库, cd到目录,然后
pip install .
配置
可以使用配置文件来配置darglint 。 配置文件必须命名为.darglint , setup.cfg或tox.ini 。 它还必须有一个以节标题[darglint]开头的节。 最后,配置文件必须位于从其调用darglint的目录中,或位于该工作目录的父目录中。
当前,配置文件允许我们忽略错误,指定消息模板,指定检查的严格性以及忽略常见异常。
错误配置
如果我们想忽略ExcessRa