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

Change return type in docstring to literal tuple to avoid bogus cross-ref....

Change return type in docstring to literal tuple to avoid bogus cross-ref. Before this change the Sphinx tried to produce cross-reference links for the returned (stdout, stderr) tuple. The docs build produced a warning because there are 2 possible cross-ref objects for `stdout`, one in `IPython.testing.iptestcontroller.TestController`, the other in `IPython.utils.capture.CapturedIO`. Neither of those is correct in the context of the `ipexec()` function. Changing literal ``(stdout, stderr)`` avoids the warning by preventing the attempt to produce cross-references.

Min RK - - Load All Authors

File last commit:

r23020:21d14a32


                r24067:fcbe9bad

Download file

             signatures.py
        
                    11 lines
            
             | 407 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / utils / signatures.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """DEPRECATED: Function signature objects for callables.

      Use the standard library version if available, as it is more up to date.

      Fallback on backport otherwise.

      """

      import warnings

      warnings.warn("{} backport for Python 2 is deprecated in IPython 6, which only supports Python 3".format(__name__),

          DeprecationWarning, stacklevel=2)

      from inspect import BoundArguments, Parameter, Signature, signature

	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

				"""DEPRECATED: Function signature objects for callables.

				Use the standard library version if available, as it is more up to date.
				Fallback on backport otherwise.
				"""

				import warnings
				warnings.warn("{} backport for Python 2 is deprecated in IPython 6, which only supports Python 3".format(__name__),
				DeprecationWarning, stacklevel=2)

				from inspect import BoundArguments, Parameter, Signature, signature