有什么方法可以检查 Python 文件是否符合 Numpy 文档风格? [关闭]

2024-03-21

我正在开发一个需要 Numpy 文档的项目。在我的 Java 时代,我记得有 linter 来检查 Eclipse/IDEA 中的 Javadoc 遵守情况;是否有类似的工具可以检查 Numpy 文档风格的一致性?

我了解 PEP257,但它似乎没有对 Numpy 文档进行任何具体检查。


Pylint 似乎支持这一点。看一眼pylint.extensions.docparams https://github.com/PyCQA/pylint/blob/master/pylint/extensions/docparams.rst.

把它们加起来。您可以通过添加来激活 pylint 检查器

load-plugins=pylint.extensions.docparams

在你的主控部分.pylintrc.

该检查器验证所有函数、方法和构造函数 文档字符串包括以下文档

  • 参数及其类型

  • 返回值及其类型

  • 提出例外情况


实际上pydoc风格 https://github.com/PyCQA/pydocstyle(以前称为 pep257)最近添加了支持 https://github.com/PyCQA/pydocstyle/pull/226对于 numpy 文档字符串约定。虽然它并不完美,但我认为它最接近您想要实现的目标,并且可能会在不久的将来有所改进。

pydocstyle --convention=numpy example.py
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

有什么方法可以检查 Python 文件是否符合 Numpy 文档风格? [关闭] 的相关文章

随机推荐