adafruit / Adafruit_CircuitPython_Colorsys

CircuitPython CPython compatible libraries
MIT License
0 stars 7 forks source link

Add RTD parameter documentation #20

Closed tekktrik closed 2 years ago

tekktrik commented 2 years ago

This library is missing Sphinx docstring documentation for ReadTheDocs for the functions contained within! See other libraries for examples. Here's a basic example of what is needed in the docstring for each function:

...

def some_function(a: float, b: int) -> Tuple[str, str, str]:
    """This is an explanation of the function

    :param float a: An explanation of parameter a
    :param int b: An explanation of parameter b
    """

...