]> granicus.if.org Git - python/commitdiff
#10420: fix docs of bdb.effective().
authorGeorg Brandl <georg@python.org>
Fri, 26 Nov 2010 12:05:48 +0000 (12:05 +0000)
committerGeorg Brandl <georg@python.org>
Fri, 26 Nov 2010 12:05:48 +0000 (12:05 +0000)
Doc/library/bdb.rst

index 3e5a54b246f97e47dd119a02c5f97d6971fc75da..1609c55fea38e1e449e2bb57c225afa9e2b62e25 100644 (file)
@@ -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.