`IPython.core.oinspect:Inspector.pdoc`

source: /dev/ipython/IPython/core/oinspect.py:483

Signature

def pdoc(self, obj, oname = '', formatter = None)

Summary

Print the docstring for any object.

Extended Summary

Optional: -formatter: a function to run the docstring through for specially formatted docstrings.

Examples

In [1]: class NoInit: ...: pass In [2]: class NoDoc: ...: def __init__(self): ...: pass In [3]: %pdoc NoDoc No documentation found for NoDoc In [4]: %pdoc NoInit No documentation found for NoInit In [5]: obj = NoInit() In [6]: %pdoc obj No documentation found for obj In [5]: obj2 = NoDoc() In [6]: %pdoc obj2 No documentation found for obj2

Aliases

IPython.core.oinspect.Inspector.pdoc