upstream/ipython Files · IPython/html.py

Fix example usage of BaseFormatter.for_type_by_name....

Fix example usage of BaseFormatter.for_type_by_name. I propose a small documentation fix for this excellent feature of IPython. The current example doesn't work because the type module and type name are lumped into one string. They must be given as separate strings. See docstring: ``` Signature: BaseFormatter.for_type_by_name(self, type_module, type_name, func=None) ``` For extra clarity, I have added a submodule to this made-up example module so that the pattern is clear.

Matthias Bussonnier - - Load All Authors

File last commit:

r23398:f33ca742


                r25165:5da2c265

Download file

             html.py
        
                    28 lines
            
             | 839 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / html.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Shim to maintain backwards compatibility with old IPython.html imports.

      """

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      import sys

      from warnings import warn

      from IPython.utils.shimmodule import ShimModule, ShimWarning

      warn("The `IPython.html` package has been deprecated since IPython 4.0. "

           "You should import from `notebook` instead. "

           "`IPython.html.widgets` has moved to `ipywidgets`.", ShimWarning)

      _widgets = sys.modules['IPython.html.widgets'] = ShimModule(

          src='IPython.html.widgets', mirror='ipywidgets')

      _html = ShimModule(

          src='IPython.html', mirror='notebook')

      # hook up widgets

      _html.widgets = _widgets

      sys.modules['IPython.html'] = _html

      if __name__ == '__main__':

          from notebook import notebookapp as app

          app.launch_new_instance()

	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

				"""
				Shim to maintain backwards compatibility with old IPython.html imports.
				"""
				# Copyright (c) IPython Development Team.
				# Distributed under the terms of the Modified BSD License.

				import sys
				from warnings import warn

				from IPython.utils.shimmodule import ShimModule, ShimWarning

				warn("The `IPython.html` package has been deprecated since IPython 4.0. "
				"You should import from `notebook` instead. "
				"`IPython.html.widgets` has moved to `ipywidgets`.", ShimWarning)

				_widgets = sys.modules['IPython.html.widgets'] = ShimModule(
				src='IPython.html.widgets', mirror='ipywidgets')

				_html = ShimModule(
				src='IPython.html', mirror='notebook')

				# hook up widgets
				_html.widgets = _widgets
				sys.modules['IPython.html'] = _html

				if __name__ == '__main__':
				from notebook import notebookapp as app
				app.launch_new_instance()