Skip to content

Add RTD parameter documentation #20

Closed
@tekktrik

Description

@tekktrik

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
    """

...

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions