##// END OF EJS Templates
expand start_ipython / embed docstrings...
MinRK -
Show More
@@ -86,10 +86,17 b' def embed_kernel(module=None, local_ns=None, **kwargs):'
86 86 real_embed_kernel(module=module, local_ns=local_ns, **kwargs)
87 87
88 88 def start_ipython(argv=None, **kwargs):
89 """launch a normal IPython instance (as opposed to embedded)
89 """Launch a normal IPython instance (as opposed to embedded)
90 90
91 This is a public API method, and will survive implementation changes.
91 `IPython.embed()` puts a shell in a particular calling scope,
92 such as a function or method for debugging purposes,
93 which is often not desirable.
94
95 `start_ipython()` does full, regular IPython initialization,
96 including loading startup files, configuration, etc.
97 much of which is skipped by `embed()`.
92 98
99 This is a public API method, and will survive implementation changes.
93 100
94 101 Parameters
95 102 ----------
@@ -97,7 +104,8 b' def start_ipython(argv=None, **kwargs):'
97 104 argv : list or None, optional
98 105 If unspecified or None, IPython will parse command-line options from sys.argv.
99 106 To prevent any command-line parsing, pass an empty list: `argv=[]`.
100
107 user_ns : dict, optional
108 specify this dictionary to initialize the IPython user namespace with particular values.
101 109 kwargs : various, optional
102 110 Any other kwargs will be passed to the Application constructor,
103 111 such as `config`.
@@ -272,6 +272,11 b' def embed(**kwargs):'
272 272 instance and then call it. Consecutive calls just call the already
273 273 created instance.
274 274
275 If you don't want the kernel to initialize the namespace
276 from the scope of the surrounding function,
277 and/or you want to load full IPython configuration,
278 you probably want `IPython.start_ipython()` instead.
279
275 280 Here is a simple example::
276 281
277 282 from IPython import embed
General Comments 0
You need to be logged in to leave comments. Login now