Docorator

class openpnm.models.geometry.throat_perimeter.Docorator(*args, **kwargs)[source]

Brief explanation of ‘Docorator’

Methods

dedent(s[, stacklevel])

Dedent a string and substitute with the params attribute.

dedents(*args, **kwargs)

Deprecated method

delete_kwargs(base_key[, args, kwargs])

Delete the *args or **kwargs part from the parameters section.

delete_kwargs_s(*args, **kwargs)

Deprecated method

delete_params(base_key, *params)

Delete a parameter from a parameter documentation.

delete_params_s(*args, **kwargs)

Deprecated function

delete_types(base_key, out_key, *types)

Delete a parameter from a parameter documentation.

delete_types_s(*args, **kwargs)

Deprecated function

get_docstring(s[, base])

Get a docstring of a function.

get_extended_summary(s[, base])

Get the extended summary from a docstring.

get_extended_summaryf(*args, **kwargs)

Deprecated method

get_full_description(s[, base])

Get the full description from a docstring.

get_full_descriptionf(*args, **kwargs)

Deprecated method

get_sections(s[, base, sections])

Exctract sections out of a docstring.

get_sectionsf(*args, **kwargs)

Deprecated method

get_summary(s[, base])

Get the summary of the given docstring.

get_summaryf(*args, **kwargs)

Deprecated method

keep_params(base_key, *params)

Keep only specific parameters from a parameter documentation.

keep_params_s(*args, **kwargs)

Deprecated function

keep_types(base_key, out_key, *types)

Keep only specific parameters from a parameter documentation.

keep_types_s(*args, **kwargs)

Deprecated function

save_docstring(*args, **kwargs)

Deprecated method

with_indent(s[, indent, stacklevel])

Substitute a string with the indented params.

with_indents(*args, **kwargs)

Deprecated method