Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc magic lsmagic #217

Closed
wants to merge 1 commit into from
Closed

Doc magic lsmagic #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 15 additions & 1 deletion IPython/core/magic.py
View file
Open in desktop
Expand Up @@ -308,7 +308,21 @@ def parse_options(self,arg_str,opt_str,*long_opts,**kw):

# Functions for IPython shell work (vars,funcs, config, etc)
def magic_lsmagic(self, parameter_s = ''):
"""List currently available magic functions."""
"""List currently available magic functions.

Examples
--------

Some explanation::

In [3]: %lsmagic
Available magic functions:
%Exit %Pprint %Quit %alias %autocall %autoindent %automagic
%bookmark %cd %colors %cpaste %debug %dhist %dirs
%doctest_mode %ed %edit %env %exit %gui %hist %history ...etc.

Automagic is ON, % prefix NOT needed for magic functions.
"""
mesc = ESC_MAGIC
print 'Available magic functions:\n'+mesc+\
(' '+mesc).join(self.lsmagic())
Expand Down