Skip to content

Doc magic lsmagic #217

Closed
wants to merge 1 commit into from
+15 −1
View
16 IPython/core/magic.py
@@ -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())
Something went wrong with that request. Please try again.