Args vs Parameters

[zchmielewska]

In docstrings of functions

[zchmielewska]

Numpy/Scipy style:

def calculate_area(radius):
    """
    Calculate the area of a circle given its radius.

    Parameters
    ----------
    radius : float
        The radius of the circle. Must be a non-negative value.

    Returns
    -------
    float
        The area of the circle.

    Raises
    ------
    ValueError
        If the radius is negative.

    Examples
    --------
    >>> calculate_area(5)
    78.53981633974483
    """
    if radius < 0:
        raise ValueError("Radius cannot be negative")
    return math.pi * radius ** 2