Sphinx 对从 IntEnum 派生的类发出警告 - 我可以对此做些什么吗?

问题描述 投票:0回答:1

正如标题所说。警告是:

docstring of liesel.goose.EpochType.from_bytes:9: WARNING: Inline interpreted text or phrase reference start-string without end-string.
docstring of liesel.goose.EpochType.to_bytes:8: WARNING: Inline interpreted text or phrase reference start-string without end-string.

我使用的是Sphinx版本

7.2.6

我的调查结果如下:

EpochType
派生自
enum.IntEnum
。 IntEnum 部分源自
int
GitHub 上的源代码)。

据我所知,方法

from_bytes
to_bytes
源自
int
上的相应方法。

我不明白为什么 sphinx 会发出这个警告和/或我能做些什么。

python python-sphinx
1个回答
0
投票

我也有同样的问题。

最小示例:

class MyClass(IntEnum):
    """Dummy enum.

    Values:

        - VALUE_ONE (1): Equal one
        - VALUE_TWO (2): Equal two
    """

    VALUE_ONE = 1
    VALUE_TWO = 2
© www.soinside.com 2019 - 2024. All rights reserved.