From df826f36e081211ef645a9025b60c4d84abb5419 Mon Sep 17 00:00:00 2001 From: Brian Curtin Date: Thu, 26 Apr 2018 19:48:26 -0400 Subject: [PATCH] Clarify the inspect.getmembers predicate parameter (#6615) 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 | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Doc/library/inspect.rst b/Doc/library/inspect.rst index bc4316faba..7db6ca68b2 100644 --- a/Doc/library/inspect.rst +++ b/Doc/library/inspect.rst @@ -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:: -- 2.40.0