upstream/ipython Files · IPython/utils/sentinel.py

Improve API documentation around configuration of embedded IPython (#13989)...

Improve API documentation around configuration of embedded IPython (#13989) This PR tries to improve the API documentation of `embed()`, `embed_kernel()`, `start_ipython()` and `start_kernel()` with respect to the configuration of IPython by adding links to other sections of the documentation. It also reorganizes the API docs so that `embed()` is listed under `IPython`, just as it's presented in the narrative documentation.

Min RK - - Load All Authors

File last commit:

r21078:2098e1d4


                r28197:ad452c1d

Download file

             sentinel.py
        
                    17 lines
            
             | 421 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / sentinel.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Sentinel class for constants with useful reprs"""

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      class Sentinel(object):

          def __init__(self, name, module, docstring=None):

              self.name = name

              self.module = module

              if docstring:

                  self.__doc__ = docstring

          def __repr__(self):

              return str(self.module)+'.'+self.name

	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

				"""Sentinel class for constants with useful reprs"""

				# Copyright (c) IPython Development Team.
				# Distributed under the terms of the Modified BSD License.

				class Sentinel(object):

				def __init__(self, name, module, docstring=None):
				self.name = name
				self.module = module
				if docstring:
				self.__doc__ = docstring


				def __repr__(self):
				return str(self.module)+'.'+self.name