1

When using type hints in the function signature, do I need to specify the parameter types in the docstring, too, if I were to comply with numpydoc style?

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

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

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

    """
    return a + b

Is the defintion for a in the parameters section sufficient?

Andi
  • 3,196
  • 2
  • 24
  • 44

0 Answers0