Skip to content

Supported Docstring format

You can read about available docstring formats in this article: Docstring Formats

We opt for Google-style which is described here: PyGuide Functions and Methods

You can use the following docstring as a reference:
def test(name: str, age: int, is_student: bool, *args: str, **kwargs: int) -> None:
    The test function...

        name (str): name of the applicant
        age (int): age of the applicant
        is_student (bool): if the applicant is a student or not
        *args (str): some variable length arguments
        **kwargs (int): keyword arguments

    Return: None