diff options
| author | Nick Coghlan <ncoghlan@gmail.com> | 2014-03-08 06:36:37 (GMT) |
|---|---|---|
| committer | Nick Coghlan <ncoghlan@gmail.com> | 2014-03-08 06:36:37 (GMT) |
| commit | 1635578d5f914ffedf767e18d4c6a95194ad1e61 (patch) | |
| tree | 84b2f879ebbd0a779e3d40dc6c3b91568d57eddb /Doc/library | |
| parent | 8591563628dfca26243ef9bf2dfac11eb0b44e77 (diff) | |
| download | cpython-1635578d5f914ffedf767e18d4c6a95194ad1e61.zip cpython-1635578d5f914ffedf767e18d4c6a95194ad1e61.tar.gz cpython-1635578d5f914ffedf767e18d4c6a95194ad1e61.tar.bz2 | |
Improve descriptions of introspection changes
Several of the introspection changes in Python 3.4 are indirect,
where inspect module changes affected pydoc, and those in turn
affected the help builtin. This update adds versionchanged
notes in the key locations, as well as more coverage in the
What's New document (in particular, a note in the porting
section regarding the expanded domain for inspect.getfullargspec).
Diffstat (limited to 'Doc/library')
| -rw-r--r-- | Doc/library/functions.rst | 4 | ||||
| -rw-r--r-- | Doc/library/inspect.rst | 5 | ||||
| -rw-r--r-- | Doc/library/pydoc.rst | 5 |
3 files changed, 14 insertions, 0 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst index 307ff51..0ee52fa 100644 --- a/Doc/library/functions.rst +++ b/Doc/library/functions.rst @@ -610,6 +610,10 @@ are always available. They are listed here in alphabetical order. This function is added to the built-in namespace by the :mod:`site` module. + .. versionchanged:: 3.4 + Changes to :mod:`pydoc` and :mod:`inspect` mean that the reported + signatures for callables are now more comprehensive and consistent. + .. function:: hex(x) diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index ccb2bd7..0c08712 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -729,6 +729,11 @@ Classes and functions Consider using the new :ref:`Signature Object <inspect-signature-object>` interface, which provides a better way of introspecting functions. + .. versionchanged:: 3.4 + This function is now based on :func:`signature`, but still ignores + ``__wrapped__`` attributes and includes the already bound first + parameter in the signature output for bound methods. + .. function:: getargvalues(frame) diff --git a/Doc/library/pydoc.rst b/Doc/library/pydoc.rst index e100865..3f520e8 100644 --- a/Doc/library/pydoc.rst +++ b/Doc/library/pydoc.rst @@ -84,3 +84,8 @@ Reference Manual pages. .. versionchanged:: 3.2 Added the ``-b`` option, deprecated the ``-g`` option. + +.. versionchanged:: 3.4 + :mod:`pydoc` now uses :func:`inspect.signature` rather than + :func:`inspect.getfullargspec` to extract signature information from + callables. |