##// END OF EJS Templates
Add note about experimental API
Thomas Kluyver -
Show More
@@ -7,6 +7,10 b' can be registered for the same event without needing to be aware of one another.'
7
7
8 The functions defined in this module are no-ops indicating the names of available
8 The functions defined in this module are no-ops indicating the names of available
9 events and the arguments which will be passed to them.
9 events and the arguments which will be passed to them.
10
11 .. note::
12
13 This API is experimental in IPython 2.0, and may be revised in future versions.
10 """
14 """
11 from __future__ import print_function
15 from __future__ import print_function
12
16
@@ -15,6 +19,10 b' class EventManager(object):'
15
19
16 This is attached to :class:`~IPython.core.interactiveshell.InteractiveShell`
20 This is attached to :class:`~IPython.core.interactiveshell.InteractiveShell`
17 instances as a ``callbacks`` attribute.
21 instances as a ``callbacks`` attribute.
22
23 .. note::
24
25 This API is experimental in IPython 2.0, and may be revised in future versions.
18 """
26 """
19 def __init__(self, shell, available_events):
27 def __init__(self, shell, available_events):
20 """Initialise the :class:`CallbackManager`.
28 """Initialise the :class:`CallbackManager`.
@@ -27,6 +27,10 b' For example::'
27 ip.callbacks.register('pre_execute', vw.pre_execute)
27 ip.callbacks.register('pre_execute', vw.pre_execute)
28 ip.callbacks.register('post_execute', vw.post_execute)
28 ip.callbacks.register('post_execute', vw.post_execute)
29
29
30 .. note::
31
32 This API is experimental in IPython 2.0, and may be revised in future versions.
33
30 .. seealso::
34 .. seealso::
31
35
32 Module :mod:`IPython.core.hooks`
36 Module :mod:`IPython.core.hooks`
General Comments 0
You need to be logged in to leave comments. Login now