Standard for Docstrings

[DavidoTek]

We should define a standard way of writing doc strings.

Suggestion 1

def my_positive_divider(dividend: float, divisor: float) -> float:
    """
    Divides the dividend by the divisor and returns the quotient.
    Only positive numbers are supported for no reason.

    Args:
        dividend (float): The number which is divided
        divisor (float): The number which is used to divide

    Returns:
        float: The result (quotient)

    Raises:
        ArithmeticError: When a negative number is supplied
        ZeroDivisionError: When the divisor is zero         # should we include inherited Exceptions?
    """

    if dividend < 0 or divisor < 0:
        raise ArithmeticError("Only positive numbers are supported!")

    quotient: float = dividend / divisor

    return quotient

A few other formats are listed here under "Docstring Formats": https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring