This is a development version (9.14.0.dev) and may be unstable. Go to latest (9.13.0)
{ } Raw JSON

bundles / IPython 9.14.0.dev / IPython / core / magic / MagicsManager / lsmagic_docs

function

IPython.core.magic:MagicsManager.lsmagic_docs

source: /IPython/core/magic.py :428

Signature

def   lsmagic_docs ( self brief : bool = False missing : str = '' )  →  dict[str, dict[str, str]]

Summary

Return dict of documentation of magic functions.

Extended Summary

The return dict has the keys 'line' and 'cell', corresponding to the two types of magics we support. Each value is a dict keyed by magic name whose value is the function docstring. If a docstring is unavailable, the value of missing is used instead.

If brief is True, only the first line of each docstring will be returned.

Aliases

  • IPython.core.magic.MagicsManager.lsmagic_docs