show_docstring#

show_docstring(func)[source]#

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

Useful for printing in a Jupyter notebook.

Parameters

func (object) – Function 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