Skip to content

Add docstrings #6

@destag

Description

@destag

It would be good to write some docstrings to describe public methods in api.py file.

Docstrings should be in format:

"""Short description.

Longer description
if needed.

Args:
    param1 (int): The first parameter.
    param2 (str): The second parameter.

Returns:
    int: Sum of param1 and length of param2.

Raises:
    ValueError: If arguments have wrong types.

"""

Metadata

Metadata

Assignees

No one assigned

    Labels

    hacktoberfestPart of the Hacktoberfest eventhelp wantedExtra attention is needed

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions