cpython: e0f4a5f09bfa (original) (raw)
Mercurial > cpython
changeset 97144:e0f4a5f09bfa
Issue #15582: Add a whatsnew entry for inspect.getdoc() changes in 3.5. Patch by Martin Panter. [#15582]
Berker Peksag berker.peksag@gmail.com | |
---|---|
date | Thu, 30 Jul 2015 18:06:30 +0300 |
parents | 89d34aea8d7e(current diff)4476b578b8fd(diff) |
children | d3b20bff9c5d |
files | Doc/library/inspect.rst Doc/whatsnew/3.5.rst |
diffstat | 2 files changed, 10 insertions(+), 0 deletions(-)[+] [-] Doc/library/inspect.rst 3 Doc/whatsnew/3.5.rst 7 |
line wrap: on
line diff
--- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -404,6 +404,9 @@ Retrieving source code a class, a method, a property or a descriptor, retrieve the documentation string from the inheritance hierarchy.
+ .. function:: getcomments(object)
--- a/Doc/whatsnew/3.5.rst
+++ b/Doc/whatsnew/3.5.rst
@@ -1139,6 +1139,13 @@ Changes in the Python API
True
when finding the empty string and the indexes are completely out of
range. See :issue:24284
.
+* The :func:inspect.getdoc
function now returns documentation strings
- inherited from base classes. Documentation strings no longer need to be
- duplicated if the inherited documentation is appropriate. To suppress an
- inherited string, an empty string must be specified (or the documentation
- may be filled in). This change affects the output of the :mod:
pydoc
- module and the :func:
help
function. See :issue:15582
. + Changes in the C API --------------------