example

Foo

Source code in src/project/example.py

class Foo:
    def baa(self, x: int):
        pass

baa(self, x)

Source code in src/project/example.py

def baa(self, x: int):
    pass

foo(param1, param2)

An example function

Parameters:

Name	Type	Description	Default
param1	int	a parameter.	required
param2	List[int]	an other parameter.	required

Returns:

Type	Description
bool	something.

Source code in src/project/example.py

def foo(param1: int, param2: List[int]) -> bool:
    """
    An example function

    Args:
        param1 (int): a parameter.
        param2 (List[int]): an other parameter.

    Returns:
        bool: something.
    """

    return True