set_docstring_for_import_func

utilipy.decorators.docstring.set_docstring_for_import_func(*path: str, package: Optional[str] = None, section: str = 'Returns') → str

Set docstring for IPython import function, from import file’s docstring.

Takes a helper function for a module and adds the content of the modules’ section. This currently only works on numpy-doc style docstrings.

Parameters

*path: str

path of import module

packagestr, optional, keyword only

package for get_path_to_file()

section: str, optiona, keyword only

numpy-doc style section name

Notes

This function might be moved