]> granicus.if.org Git - python/commitdiff
Clarify the inspect.getmembers predicate parameter (#6615)
authorBrian Curtin <brian@python.org>
Thu, 26 Apr 2018 23:48:26 +0000 (19:48 -0400)
committerGitHub <noreply@github.com>
Thu, 26 Apr 2018 23:48:26 +0000 (19:48 -0400)
Previously, the predicate parameter was mentioned, but what it was to be
called with was not documented and required either trial-and-error or
looking into the source to find that it is called with the `value`, or
second item, of the full members list. This change addresses what the
predicate will receive, as well as does some light formatting to make
this clear.

Doc/library/inspect.rst

index bc4316fabaee5825a031a54d853a0d9f8e1efb09..7db6ca68b23ca095f9afdecdc2e126170bc04ba1 100644 (file)
@@ -247,9 +247,10 @@ attributes:
 
 .. function:: getmembers(object[, predicate])
 
-   Return all the members of an object in a list of (name, value) pairs sorted by
-   name.  If the optional *predicate* argument is supplied, only members for which
-   the predicate returns a true value are included.
+   Return all the members of an object in a list of ``(name, value)``
+   pairs sorted by name. If the optional *predicate* argument—which will be
+   called with the ``value`` object of each member—is supplied, only members
+   for which the predicate returns a true value are included.
 
    .. note::