NumpyDoc：当我使用类型提示时，我可以省略DocString中的类型声明吗？

Question

在功能签名中使用类型提示时，如果我遵守NumpyDoc样式，我是否也需要指定DocString中的参数类型？

def add(a: float, b: int) -> float:
    """

    Parameters
    ----------
    a
        Fist number.
    b : int
        Second number.

    Returns
    -------
    float
        Result of a + b

    """
    return a + b

参数部分中的 a 的定义是否足够？

Answer 1

目前，我认为答案是 no ，如果您想使用 numpydoc python package 直接。有一个公开票： https://github.com/numpy/numpy/numpydoc/issues/196 <196 <196 <196 < /a>

我希望任何更改也会出现在 numpydoc 文档。

但是：渲染 DocStrings 用 numpydoc -like 类型 hinted样式通过其他软件包。这是我发现的（部分通过 numpydoc 问题）：

• /code> 是支持此 DocString 解析器href =“ https://mkdocstrings.github.io/griffe/docstrings/#numpydoc-style” rel =“ nofollow noreferrer”> numpydoc-style 。这是通过：
  • mkdocs 通过 mkdocstrings
  • QUARTO 通过 Quartodoc （请参阅 nofollow noreferrer“> resucty-instem-insus-usess-insus-insus-insus-insus-indy-type-type-type-nottation ）

• sphinx 通过 sphinx-autodoc-typehints