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], list[str], list[str], list[str]]

Get lists of strings depending on Python file sections.

Parameters:

filename: str

Path containing the Python file.

Returns:

Tuple[List[str], List[str], List[str], List[str], List[str], List[str], List[str]]

Tuple containing lists of strings for different sections of the Python file. The order of the lists is as follows: - Arguments list - Parameters section - Returns section - Notes section - Examples section - Source code - Library import section