pycsamt.api.docs

Reusable docstring fragments for PyCSAMT APIs.

Classes

DocstringComponents(comp_dict[, ...])

Store docstring fragments with dot-style access.

class pycsamt.api.docs.DocstringComponents(comp_dict, strip_whitespace=True)

Bases: object

Store docstring fragments with dot-style access.

Parameters:

• comp_dict (dict[str, str])

• strip_whitespace (bool)

regexp = re.compile('\\n((\\n|.)+)\\n\\s*', re.MULTILINE)

classmethod from_nested_components(**kwargs)

Parameters:

kwargs (DocstringComponents)

Return type:

DocstringComponents