##// END OF EJS Templates
docs: embed: add parameters to docstring...
docs: embed: add parameters to docstring The docstring of IPython.terminal.embed.embed() does not document its arguments. Add a "Parameters" section, and document each argument appropriately: - for 'header', rephrase the corresponding description from the docstring of InteractiveShellEmbed.__call__, to which this argument is passed (__call__ itself is missing from the generated API documentation since sphinx.ext.autodoc does not document special members by default). - for 'compile_flags', refer to the documentation of InteractiveShellEmbed.mainloop, to which this argument is passed. - for 'kwargs', refer to the constructor of InteractiveShellEmbed, and fold in the sentence mentioning the 'config' argument.

File last commit:

r28076:7f8f8ea0
r28186:97d929ec
Show More
index.rst
31 lines | 961 B | text/x-rst | RstLexer

.. _terminal-shortcuts-list:

=================
IPython shortcuts
=================

Shortcuts available in an IPython terminal.

.. note::

This list is automatically generated. Key bindings defined in ``prompt_toolkit`` may differ
between installations depending on the ``prompt_toolkit`` version.


* Comma-separated keys, e.g. :kbd:`Esc`, :kbd:`f`, indicate a sequence which can be activated by pressing the listed keys in succession.
* Plus-separated keys, e.g. :kbd:`Esc` + :kbd:`f` indicate a combination which requires pressing all keys simultaneously.
* Hover over the ⓘ icon in the filter column to see when the shortcut is active.

You can use :std:configtrait:`TerminalInteractiveShell.shortcuts` configuration
to modify, disable or add shortcuts.

.. role:: raw-html(raw)
:format: html


.. csv-table::
:header: Shortcut,Description and identifier,Filter
:delim: tab
:class: shortcuts
:file: table.tsv
:widths: 20 75 5