From: Georg Brandl <georg@python.org>
Date: Fri, 26 Nov 2010 12:05:48 +0000 (+0000)
Subject: #10420: fix docs of bdb.effective().
X-Git-Tag: v3.2b1~202
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f51a6c7d74fc9a0f933f7d2bd746ce7fd2b82a4c;p=python

#10420: fix docs of bdb.effective().
---

diff --git a/Doc/library/bdb.rst b/Doc/library/bdb.rst
index 3e5a54b246..1609c55fea 100644
--- a/Doc/library/bdb.rst
+++ b/Doc/library/bdb.rst
@@ -359,12 +359,10 @@ Finally, the module defines the following functions:
 .. function:: effective(file, line, frame)
 
    Determine if there is an effective (active) breakpoint at this line of code.
-   Return breakpoint number or 0 if none.
-
-   Called only if we know there is a breakpoint at this location.  Returns the
-   breakpoint that was triggered and a flag that indicates if it is ok to delete
-   a temporary breakpoint.
+   Return a tuple of the breakpoint and a boolean that indicates if it is ok
+   to delete a temporary breakpoint.  Return ``(None, None)`` if there is no
+   matching breakpoint.
 
 .. function:: set_trace()
 
-   Starts debugging with a :class:`Bdb` instance from caller's frame.
+   Start debugging with a :class:`Bdb` instance from caller's frame.