urbanoctowaddle.example_google.function_with_types_in_docstring

urbanoctowaddle.example_google.function_with_types_in_docstring(param1, param2)

Example function with types documented in the docstring.

PEP 484 type annotations are supported. If attribute, parameter, and return types are annotated according to PEP 484, they do not need to be included in the docstring:

Parameters:

• param1 (int) – The first parameter.
• param2 (str) – The second parameter.

Returns:

The return value. True for success, False otherwise.

Return type:

bool