检查是否记录了所有参数。
docargs的Python项目详细描述
文档
一个检查您是否记录了所有参数的包。
docargs的编写考虑到了持续的集成:它将引发一个错误 如果您没有记录所有的函数参数。很容易忘记,但是 同样重要的是不要-所以你应该自动测试它!
要使用,只需pip install docargs
,然后运行docargs mypackage/**/*py
。或者,docargs与flake8集成,因此运行flake8 mypackage
也可以工作。
要查看它的运行情况,请查看travis ci配置 关于这个repository
目前,docargs
只适用于numpydoc
样式的docstring。