summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorBerker Peksag <berker.peksag@gmail.com>2015-07-30 15:06:09 (GMT)
committerBerker Peksag <berker.peksag@gmail.com>2015-07-30 15:06:09 (GMT)
commit4333d8bad72c8fa3ff563284edb090e6541022b0 (patch)
tree825488c0a686a5e2fe8a60145a1f6d076c7d2ce1 /Doc
parent61d5aab9b9fc81ca8801d94af8032414f745b8c2 (diff)
downloadcpython-4333d8bad72c8fa3ff563284edb090e6541022b0.zip
cpython-4333d8bad72c8fa3ff563284edb090e6541022b0.tar.gz
cpython-4333d8bad72c8fa3ff563284edb090e6541022b0.tar.bz2
Issue #15582: Add a whatsnew entry for inspect.getdoc() changes in 3.5.
Patch by Martin Panter.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/inspect.rst3
-rw-r--r--Doc/whatsnew/3.5.rst7
2 files changed, 10 insertions, 0 deletions
diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst
index 66b9238..3b62e7f 100644
--- a/Doc/library/inspect.rst
+++ b/Doc/library/inspect.rst
@@ -423,6 +423,9 @@ Retrieving source code
a class, a method, a property or a descriptor, retrieve the documentation
string from the inheritance hierarchy.
+ .. versionchanged:: 3.5
+ Documentation strings are now inherited if not overridden.
+
.. function:: getcomments(object)
diff --git a/Doc/whatsnew/3.5.rst b/Doc/whatsnew/3.5.rst
index 3a3d405..dba3ea0 100644
--- 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
--------------------