]> granicus.if.org Git - python/commitdiff
Issue #15582: Add a whatsnew entry for inspect.getdoc() changes in 3.5.
authorBerker Peksag <berker.peksag@gmail.com>
Thu, 30 Jul 2015 15:06:09 +0000 (18:06 +0300)
committerBerker Peksag <berker.peksag@gmail.com>
Thu, 30 Jul 2015 15:06:09 +0000 (18:06 +0300)
Patch by Martin Panter.

Doc/library/inspect.rst
Doc/whatsnew/3.5.rst

index 66b92384f0722e7dedb520ad99a1a8d75cb95597..3b62e7f5b975bfeb9e6ef95d29a342e538906b70 100644 (file)
@@ -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)
 
index 3a3d4050555446fa062beb8ab171aeb55d89d404..dba3ea0d102e42341614a0c2b2daef4db987952a 100644 (file)
@@ -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
 --------------------