upstream/ipython Files · docs/source/config/shortcuts/index.rst

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.

krassowski - - Load All Authors

File last commit:

r28076:7f8f8ea0


                r28186:97d929ec

Download file

             index.rst
        
                    31 lines
            
             | 961 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / source / config / shortcuts / index.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        krassowski
    
Improve documentation for shortcuts

              r28076
            
      .. _terminal-shortcuts-list:

        klonuo
    
Added keyboard shortcuts docs

              r22590
            
      =================

      IPython shortcuts

      =================

        krassowski
    
Improve documentation for shortcuts

              r28076
            
      Shortcuts available in an IPython terminal.

        klonuo
    
Added keyboard shortcuts docs

              r22590
            
        krassowski
    
Restore shortcuts in documentation, define identifiers

              r28010
            
      .. note::

        Matthias Bussonnier
    
Add extra warnings in docs, and improve Makefile....

              r22622
            
        krassowski
    
Restore shortcuts in documentation, define identifiers

              r28010
            
        This list is automatically generated. Key bindings defined in ``prompt_toolkit`` may differ

        between installations depending on the ``prompt_toolkit`` version.

        Matthias Bussonnier
    
Add extra warnings in docs, and improve Makefile....

              r22622
            
        klonuo
    
Added keyboard shortcuts docs

              r22590
            
        krassowski
    
Restore shortcuts in documentation, define identifiers

              r28010
            
      * 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.

        krassowski
    
Improve documentation for shortcuts

              r28076
            
      * 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.

        klonuo
    
Added keyboard shortcuts docs

              r22590
            
        krassowski
    
Restore shortcuts in documentation, define identifiers

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

         :format: html

        klonuo
    
Added keyboard shortcuts docs

              r22590
            
      .. csv-table::

        krassowski
    
Restore shortcuts in documentation, define identifiers

              r28010
            
          :header: Shortcut,Description and identifier,Filter

        klonuo
    
Added keyboard shortcuts docs

              r22590
            
          :delim: tab

        krassowski
    
Restore shortcuts in documentation, define identifiers

              r28010
            
          :class: shortcuts

          :file: table.tsv

          :widths: 20 75 5

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

krassowski Improve documentation for shortcuts	r28076	.. _terminal-shortcuts-list:

klonuo Added keyboard shortcuts docs	r22590	=================
		IPython shortcuts
		=================

krassowski Improve documentation for shortcuts	r28076	Shortcuts available in an IPython terminal.
klonuo Added keyboard shortcuts docs	r22590
krassowski Restore shortcuts in documentation, define identifiers	r28010	.. note::
Matthias Bussonnier Add extra warnings in docs, and improve Makefile....	r22622
krassowski Restore shortcuts in documentation, define identifiers	r28010	This list is automatically generated. Key bindings defined in ``prompt_toolkit`` may differ
		between installations depending on the ``prompt_toolkit`` version.
Matthias Bussonnier Add extra warnings in docs, and improve Makefile....	r22622
klonuo Added keyboard shortcuts docs	r22590
krassowski Restore shortcuts in documentation, define identifiers	r28010	* 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.
krassowski Improve documentation for shortcuts	r28076	* 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.
klonuo Added keyboard shortcuts docs	r22590
krassowski Restore shortcuts in documentation, define identifiers	r28010	.. role:: raw-html(raw)
		:format: html
klonuo Added keyboard shortcuts docs	r22590

		.. csv-table::
krassowski Restore shortcuts in documentation, define identifiers	r28010	:header: Shortcut,Description and identifier,Filter
klonuo Added keyboard shortcuts docs	r22590	:delim: tab
krassowski Restore shortcuts in documentation, define identifiers	r28010	:class: shortcuts
		:file: table.tsv
		:widths: 20 75 5