Commit 735e236b authored by Jay Oster's avatar Jay Oster Committed by GitHub

Fix documentation for Pool.full()

The original docs had the purpose of the boolean return value reversed. I fixed that distinction, and also tried to clarify how the method can be used.
parent 2849d246
......@@ -712,8 +712,10 @@ class Pool(Group):
def full(self):
"""
Return a boolean indicating whether this pool has any room for
members. (True if it does, False if it doesn't.)
Return a boolean indicating whether this pool is full, e.g. if
:meth:`add` would block.
:return: False if there is room for new members, True if there isn't.
"""
return self.free_count() <= 0
......
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