allennlp 编写一个CI检查,确保文档字符串与构造函数保持同步,

rks48beu  于 5个月前  发布在  其他
关注(0)|答案(5)|浏览(64)

这是原材料,如果有时间我会把所有的零件都放在一起。你需要收集图书馆里的所有课程,找到双向参数,并确保它们相等。可能有很多边缘情况。

sgtfey8w

sgtfey8w1#

与此相关的是,是否有任何原因不将docstring linter(如pydocstyle)添加到测试中?我认为pydocstyle不会捕获这类错误,尤其是,但它会捕获很多其他的东西。

h5qlskok

h5qlskok2#

有一个名为pylint的扩展可以执行这个检查。We investigated it a while ago,我们最终放弃了它,因为它在声明失败时过于激进(没有明显的错误信息),并且它没有解决构造函数和from_params之间的不匹配问题(现在已经不是问题了)。我认为大家的共识是,我们确实希望有一个检查,当我们在文档字符串中列出参数时,它们需要与函数的参数相匹配,但我们还没有找到一个适合我们的。如果你知道一个,欢迎提供建议。

z3yyvxxp

z3yyvxxp3#

如果有人想尝试让这个实际工作,这里还有一些其他的想法。

myss37ts

myss37ts4#

关闭,因为我们不再使用numpy风格的docstrings。

6xfqseft

6xfqseft5#

重新开放,这将是很好的,也许现在有一个linter,因为我们已经切换了文档字符串的样式。

相关问题