1

我正在为一个包开发文档,当我构建 sphinx 文档时,我得到了双冒号

双冒号

对于每个函数定义的所有字段。

我正在为我的文档字符串使用 numpydoc 样式,并且这些文档中没有冒号来指示它们可能来自哪里:

    """

    Function description

    Parameters
    -----------
    param1: str or list
        A description for the parameter

    Returns
    -----------
    Dictionary
        Some info about what is returned

    Examples
    -----------
        >>> output = somefunction(param1)

    """

有没有人遇到过这个?值得注意的是,这不会发生在该Examples领域。只是Parameters,ReturnsReturn Type.

4

1 回答 1

0

似乎是某些版本的错误。我从狮身人面像搬到3.5.24.4.0双冒号消失了。

于 2022-01-25T18:21:25.147 回答