我正在使用 pydocstyle,我想知道为什么它会针对我的代码引发错误
D407 / Missing dashed underline after section ('Example')
。
我的代码如下所示:
def foo():
"""
Function description here...
Example:
Some example here...
"""
# some code here
过去当我尝试添加
Note:
部分时,我也遇到过类似的问题。我想知道这是否是假阳性错误,因为我正在使用 reStructuredText 并且我知道 pydocstyle 有时在区分 reST 与 Google 和 numpy 样式时存在问题。如果我错了,请纠正我,但与默认约定下描述的
pep257
部分无关,所以我可以从字面上关闭所有这些检查:D203,D212,D213,...,D407,。 ..?
看来我的预感是正确的,D407 是与 reStructuredText 无关的错误之一。
Note:
(与 Example:
相同)部分在 reStructuredText 中未使用,因为应使用 ..note::
来代替。
这意味着您需要在
-------
之后添加一行 Example:
,如下所示 https://beta.ruff.rs/docs/rules/dashed-underline-after-section/
您的情况:
def foo():
"""
Function description here...
Example
-------
Some example here...
"""
# some code here