From 9d0ebbe240ca12c1791463e27cc6e569d6315263 2013-08-27 17:30:03
From: Thomas Kluyver <takowl@gmail.com>
Date: 2013-08-27 17:30:03
Subject: [PATCH] Merge pull request #4115 from takluyver/doc-register-magic-func

Update docs on declaring a magic function
---

diff --git a/IPython/core/interactiveshell.py b/IPython/core/interactiveshell.py
index daee6ab..3453fc6 100644
--- a/IPython/core/interactiveshell.py
+++ b/IPython/core/interactiveshell.py
@@ -22,6 +22,7 @@ import __future__
 import abc
 import ast
 import atexit
+import functools
 import os
 import re
 import runpy
@@ -2028,7 +2029,6 @@ class InteractiveShell(SingletonConfigurable):
 
         # Expose as public API from the magics manager
         self.register_magics = self.magics_manager.register
-        self.register_magic_function = self.magics_manager.register_function
         self.define_magic = self.magics_manager.define_magic
 
         self.register_magics(m.AutoMagics, m.BasicMagics, m.CodeMagics,
@@ -2052,6 +2052,12 @@ class InteractiveShell(SingletonConfigurable):
         # should be split into a prompt manager and displayhook. We probably
         # even need a centralize colors management object.
         self.magic('colors %s' % self.colors)
+    
+    # Defined here so that it's included in the documentation
+    @functools.wraps(magic.MagicsManager.register_function)
+    def register_magic_function(self, func, magic_kind='line', magic_name=None):
+        self.magics_manager.register_function(func, 
+                                  magic_kind=magic_kind, magic_name=magic_name)
 
     def run_line_magic(self, magic_name, line):
         """Execute the given line magic.
diff --git a/docs/source/config/extensions/index.rst b/docs/source/config/extensions/index.rst
index 361fbee..1b47776 100644
--- a/docs/source/config/extensions/index.rst
+++ b/docs/source/config/extensions/index.rst
@@ -57,7 +57,7 @@ IPython at that point.
 the extension again. It is up to the extension author to add code to manage
 that.
 
-Useful :class:`InteractiveShell` methods include :meth:`~IPython.core.interactiveshell.InteractiveShell.define_magic`, 
+Useful :class:`InteractiveShell` methods include :meth:`~IPython.core.interactiveshell.InteractiveShell.register_magic_function`, 
 :meth:`~IPython.core.interactiveshell.InteractiveShell.push` (to add variables to the user namespace) and 
 :meth:`~IPython.core.interactiveshell.InteractiveShell.drop_by_id` (to remove variables on unloading).