在 pydocstyle 的忽略文件中使用错误名称而不是错误代码

Question

我的团队使用pydocstyle管理文档字符串标准化的repo。我的任务是重新格式化相关配置文件。目前它看起来像这样:

[pydocstyle]
ignore = D100,D203,D405
match = *.py

，但我们想要更像:

[pydocstyle]
ignore = "error-name1", "error-name2", "error-name3"
match = *.py

以便读者更清楚地看到哪些规则被忽略了。然而，从我所看到的，这在文档中没有提到(在这里)。

我想我应该这样做:

[pydocstyle]
ignore = 
D100,       # corresponds to "error-name1"
D203,       # corresponds to "error-name2"
D405        # corresponds to "error-name3"
match = *.py

但是我不知道这个文件中的语法是否有效，或者如何检查。

我的问题是:

1. 是否有一种方法来完成我被赋予的原始任务(ignore="error-name1"等)?
2. 如果不是，我的伪解决方案会工作吗?

非常感谢您的帮助!

Answer 1

伪解决方案很好。你可以通过运行

来测试它

pydocstyle --config=name_of_config_file

在控制台。注意name_of_config_file必须符合这里列出的标准之一。