Commit ff5632ef authored by Jason Madden's avatar Jason Madden

Document that successful() is True if killed with a GreenletExit. [skip ci]

parent 4293f032
...@@ -225,7 +225,11 @@ class Greenlet(greenlet): ...@@ -225,7 +225,11 @@ class Greenlet(greenlet):
def successful(self): def successful(self):
"""Return true if and only if the greenlet has finished execution successfully, """Return true if and only if the greenlet has finished execution successfully,
that is, without raising an error.""" that is, without raising an error.
.. note:: A greenlet that has been killed with the default :class:`GreenletExit` exception
is considered successful. That is, ``GreenletExit`` is not considered an error.
"""
return self._exc_info and self._exc_info[1] is None return self._exc_info and self._exc_info[1] is None
def __repr__(self): def __repr__(self):
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment