porespy.tools.show_docstring

porespy.tools.show_docstring(func)

Fetches the docstring for a function and returns it in markdown format.

Useful for printing in a Jupyter notebook.

Parameters:

func (object) – Handle to function whose docstring is desired

Returns:

md – A string with the markdown syntax included, suitable for printing in a Jupyter notebook using the IPython.display.Markdown function.

Return type:

str