urbanoctowaddle.example_numpy.function_with_types_in_docstring¶
-
urbanoctowaddle.example_numpy.function_with_types_in_docstring(param1, param2)[source]¶ 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: - bool – True if successful, False otherwise.
- .. _PEP 484 – https://www.python.org/dev/peps/pep-0484/