upstream/ipython Files · IPython/core/magics/__init__.py

Backport PR : qtconsole: wrap argument list in tooltip to match width of text body...

Backport PR : qtconsole: wrap argument list in tooltip to match width of text body previously, a function with a long argument list would produce a very wide tooltip, hurting readability. Since the width of the docstring body is chosen by the developer whereas the formatting of the argument list is currently not, it's reasonable to wrap the argument list width to the maximum of a) 80 characters, or b) maximum length of a line in the docstring body. This improves readability, without unduly affecting the appearence of the docstring body itself. closes I'm happy to add any additional tests or make any changes required to get this merged.

MinRK - - Load All Authors

File last commit:

r7299:cdde5bba


                r9846:43e0fc22

Download file

             __init__.py
        
                    41 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / core / magics / __init__.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Fernando Perez
    
Create new core.magics package and start populating with history.

              r6956
            
      """Implementation of all the magic functions built into IPython.

      """

      #-----------------------------------------------------------------------------

        Fernando Perez
    
Create decorators for standalone magic functions, as per review.x

              r6972
            
      #  Copyright (c) 2012 The IPython Development Team.

        Fernando Perez
    
Create new core.magics package and start populating with history.

              r6956
            
      #

      #  Distributed under the terms of the Modified BSD License.

      #

      #  The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

        Fernando Perez
    
Move UserMagics to core.magics

              r6957
            
        Fernando Perez
    
Renamed @register_magics to @magics_class to avoid confusion....

              r6973
            
      from ..magic import Magics, magics_class

        Fernando Perez
    
Create core.magics.auto according to new API.

              r6964
            
      from .auto import AutoMagics

        Fernando Perez
    
Create core.magics.code according to new API.

              r6960
            
      from .basic import BasicMagics

      from .code import CodeMagics, MacroToEdit

        Fernando Perez
    
Create core.magics.config according to new API.

              r6961
            
      from .config import ConfigMagics

        Fernando Perez
    
Create core.magics.deprecated according to new API.

              r6969
            
      from .deprecated import DeprecatedMagics

        Fernando Perez
    
Create core.magics.execution according to new API.

              r6963
            
      from .execution import ExecutionMagics

        Fernando Perez
    
Create core.magics.extension according to new API.

              r6967
            
      from .extension import ExtensionMagics

        Fernando Perez
    
Create core.magics.code according to new API.

              r6960
            
      from .history import HistoryMagics

        Fernando Perez
    
Create core.magics.logging according to new API.

              r6966
            
      from .logging import LoggingMagics

        Fernando Perez
    
Create core.magics.namespace according to new API.

              r6962
            
      from .namespace import NamespaceMagics

        Fernando Perez
    
Create core.magics.osm according to new API.

              r6965
            
      from .osm import OSMagics

        Fernando Perez
    
Create core.magics.pylab according to new API.

              r6968
            
      from .pylab import PylabMagics

        MinRK
    
add script magics...

              r7299
            
      from .script import ScriptMagics

        Fernando Perez
    
Move UserMagics to core.magics

              r6957
            
      #-----------------------------------------------------------------------------

      # Magic implementation classes

      #-----------------------------------------------------------------------------

        Fernando Perez
    
Renamed @register_magics to @magics_class to avoid confusion....

              r6973
            
      @magics_class

        Fernando Perez
    
Move UserMagics to core.magics

              r6957
            
      class UserMagics(Magics):

          """Placeholder for user-defined magics to be added at runtime.

          All magics are eventually merged into a single namespace at runtime, but we

          use this class to isolate the magics defined dynamically by the user into

          their own class.

          """

	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

Fernando Perez Create new core.magics package and start populating with history.	r6956	"""Implementation of all the magic functions built into IPython.
		"""
		#-----------------------------------------------------------------------------
Fernando Perez Create decorators for standalone magic functions, as per review.x	r6972	# Copyright (c) 2012 The IPython Development Team.
Fernando Perez Create new core.magics package and start populating with history.	r6956	#
		# Distributed under the terms of the Modified BSD License.
		#
		# The full license is in the file COPYING.txt, distributed with this software.
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Imports
		#-----------------------------------------------------------------------------
Fernando Perez Move UserMagics to core.magics	r6957
Fernando Perez Renamed @register_magics to @magics_class to avoid confusion....	r6973	from ..magic import Magics, magics_class
Fernando Perez Create core.magics.auto according to new API.	r6964	from .auto import AutoMagics
Fernando Perez Create core.magics.code according to new API.	r6960	from .basic import BasicMagics
		from .code import CodeMagics, MacroToEdit
Fernando Perez Create core.magics.config according to new API.	r6961	from .config import ConfigMagics
Fernando Perez Create core.magics.deprecated according to new API.	r6969	from .deprecated import DeprecatedMagics
Fernando Perez Create core.magics.execution according to new API.	r6963	from .execution import ExecutionMagics
Fernando Perez Create core.magics.extension according to new API.	r6967	from .extension import ExtensionMagics
Fernando Perez Create core.magics.code according to new API.	r6960	from .history import HistoryMagics
Fernando Perez Create core.magics.logging according to new API.	r6966	from .logging import LoggingMagics
Fernando Perez Create core.magics.namespace according to new API.	r6962	from .namespace import NamespaceMagics
Fernando Perez Create core.magics.osm according to new API.	r6965	from .osm import OSMagics
Fernando Perez Create core.magics.pylab according to new API.	r6968	from .pylab import PylabMagics
MinRK add script magics...	r7299	from .script import ScriptMagics
Fernando Perez Move UserMagics to core.magics	r6957
		#-----------------------------------------------------------------------------
		# Magic implementation classes
		#-----------------------------------------------------------------------------

Fernando Perez Renamed @register_magics to @magics_class to avoid confusion....	r6973	@magics_class
Fernando Perez Move UserMagics to core.magics	r6957	class UserMagics(Magics):
		"""Placeholder for user-defined magics to be added at runtime.

		All magics are eventually merged into a single namespace at runtime, but we
		use this class to isolate the magics defined dynamically by the user into
		their own class.
		"""