numpydoc：当我使用类型提示时，我可以省略文档字符串中的类型声明吗？

Question

在函数签名中使用类型提示时，如果我要遵守 numpydoc 风格，是否也需要在文档字符串中指定参数类型？

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

目前我认为答案是否，如果你想直接使用

numpydoc

。有一张开放票：https://github.com/numpy/numpydoc/issues/196

我希望任何更改都将在

numpydoc

文档中。

但是：如果您希望使用

docstrings

包

以类似numpydoc的风格

渲染

numpydoc，那么您可能有选择。

这是我发现的（部分是通过那个

numpydoc

问题）：

• griffe 是一个支持此

  docstring

  的

  numpydoc-sytle

  解析器。这是由以下人员使用的：
  • MkDocs通过mkdocstrings
  • quarto通过quartodoc（参见使用类型注释的结果）
• Sphinx通过sphinx-autodoc-typehints