##// END OF EJS Templates
docs: embed: add parameters to docstring...
Philippe Blain -
Show More
@@ -369,8 +369,18 b' def embed(*, header="", compile_flags=None, **kwargs):'
369 d = 40
369 d = 40
370 embed()
370 embed()
371
371
372 Full customization can be done by passing a traitlets :class:`Config` in as the
372 Parameters
373 `config` argument (see :ref:`configure_start_ipython`).
373 ----------
374
375 header : str
376 Optional header string to print at startup.
377 compile_flags
378 Passed to the `compile_flags` parameter of :py:meth:`InteractiveShellEmbed.mainloop()`,
379 which is called when the :class:`InteractiveShellEmbed` instance is called.
380 **kwargs : various, optional
381 Any other kwargs will be passed to the :class:`InteractiveShellEmbed` constructor.
382 Full customization can be done by passing a traitlets :class:`Config` in as the
383 `config` argument (see :ref:`configure_start_ipython`).
374 """
384 """
375 config = kwargs.get('config')
385 config = kwargs.get('config')
376 if config is None:
386 if config is None:
General Comments 0
You need to be logged in to leave comments. Login now