Update docs about embedding.

takluyver · Dec 12, 2011 · feb3b24 · feb3b24
1 parent 2bbef0c
commit feb3b24
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 16 deletions.
diff --git a/IPython/frontend/terminal/embed.py b/IPython/frontend/terminal/embed.py
@@ -104,21 +104,18 @@ def __call__(self, header='', local_ns=None, module=None, dummy=None,
                  stack_depth=1, global_ns=None):
         """Activate the interactive interpreter.
 
-        __call__(self,header='',local_ns=None,global_ns,dummy=None) -> Start
+        __call__(self,header='',local_ns=None,module=None,dummy=None) -> Start
         the interpreter shell with the given local and global namespaces, and
         optionally print a header string at startup.
 
         The shell can be globally activated/deactivated using the
-        set/get_dummy_mode methods. This allows you to turn off a shell used
+        dummy_mode attribute. This allows you to turn off a shell used
         for debugging globally.
 
         However, *each* time you call the shell you can override the current
         state of dummy_mode with the optional keyword parameter 'dummy'. For
-        example, if you set dummy mode on with IPShell.set_dummy_mode(1), you
-        can still have a specific call work by making it as IPShell(dummy=0).
-
-        The optional keyword parameter dummy controls whether the call
-        actually does anything.
+        example, if you set dummy mode on with IPShell.dummy_mode = True, you
+        can still have a specific call work by making it as IPShell(dummy=False).
         """
 
         # If the user has turned it off, go away
@@ -160,13 +157,13 @@ def mainloop(self, local_ns=None, module=None, stack_depth=0,
 
           - header: An optional header message can be specified.
 
-          - local_ns, global_ns: working namespaces. If given as None, the
-          IPython-initialized one is updated with __main__.__dict__, so that
-          program variables become visible but user-specific configuration
-          remains possible.
+          - local_ns, module: working local namespace (a dict) and module (a
+          module or similar object). If given as None, they are automatically
+          taken from the scope where the shell was called, so that
+          program variables become visible.
 
           - stack_depth: specifies how many levels in the stack to go to
-          looking for namespaces (when local_ns and global_ns are None).  This
+          looking for namespaces (when local_ns or module is None).  This
           allows an intermediate caller to make sure that this function gets
           the namespace from the intended level in the stack.  By default (0)
           it will get its locals and globals from the immediate caller.

diff --git a/docs/source/whatsnew/development.txt b/docs/source/whatsnew/development.txt
@@ -145,10 +145,12 @@ Backwards incompatible changes
   The full path will still work, and is necessary for using custom launchers not in
   IPython's launcher module.
 
-* For embedding a shell, note that the parameter ``user_global_ns`` has been
-  replaced by ``user_module``, and expects a module-like object, rather than
-  a namespace dict. The ``user_ns`` parameter works the same way as before, and
+* For embedding a shell, note that the parameters ``user_global_ns`` and ``global_ns``
+  have been deprectated in favour of ``user_module`` and ``module`` respsectively.
+  The new parameters expect a module-like object, rather than a namespace dict.
+  The old parameters remain for backwards compatibility, although ``user_global_ns``
+  is now ignored. The ``user_ns`` parameter works the same way as before, and
   calling :func:`~IPython.frontend.terminal.embed.embed` with no arguments still
-  works the same way.
+  works as before.
 
 .. * use bullet list