The `custom_functions.py` module#

Summary#

Classes

CustomFunctions

Provides for creating customized functions.

Functions

get_docstring_lists

Get lists of strings depending on Python file sections.

Module detail#

custom_functions.get_docstring_lists(filename: str) → Tuple[list[str], list[str], list[str], list[str]]#

Get lists of strings depending on Python file sections.

Parameters:

filename: str: Path containing the Python file.

Returns:

List[str]: List containing the docstring Parameters section.
List[str]: List containing the docstring Returns section.
List[str]: List containing the docstring Notes section.
List[str]: List containing the docstring Examples section.
List[str]: List containing the source code.
List[str]: List containing the library import section.