Commit ef6588d2 authored by Jason Madden's avatar Jason Madden

Documentation tweaks.

parent ee964f81
...@@ -17,9 +17,8 @@ class Semaphore(AbstractLinkable): # pylint:disable=undefined-variable ...@@ -17,9 +17,8 @@ class Semaphore(AbstractLinkable): # pylint:disable=undefined-variable
""" """
Semaphore(value=1) -> Semaphore Semaphore(value=1) -> Semaphore
.. note:: .. seealso:: :class:`BoundedSemaphore` for a safer version that prevents
Most users should prefer :class:`BoundedSemaphore`, a safer some classes of bugs. If unsure, most users should opt for `BoundedSemaphore`.
subclass of this class.
A semaphore manages a counter representing the number of `release` A semaphore manages a counter representing the number of `release`
calls minus the number of `acquire` calls, plus an initial value. calls minus the number of `acquire` calls, plus an initial value.
...@@ -35,8 +34,6 @@ class Semaphore(AbstractLinkable): # pylint:disable=undefined-variable ...@@ -35,8 +34,6 @@ class Semaphore(AbstractLinkable): # pylint:disable=undefined-variable
This Semaphore's ``__exit__`` method does not call the trace function This Semaphore's ``__exit__`` method does not call the trace function
on CPython, but does under PyPy. on CPython, but does under PyPy.
.. seealso:: :class:`BoundedSemaphore` for a safer version that prevents
some classes of bugs.
.. versionchanged:: 1.4.0 .. versionchanged:: 1.4.0
Document that the order in which waiters are awakened is not specified. It was not Document that the order in which waiters are awakened is not specified. It was not
......
# Copyright (c) 2009-2012 Denis Bilenko. See LICENSE for details. # Copyright (c) 2009-2012 Denis Bilenko. See LICENSE for details.
"""Locking primitives""" """
Locking primitives.
These include semaphores with arbitrary bounds (:class:`Semaphore` and
its safer subclass :class:`BoundedSemaphore`) and a semaphore with
infinite bounds (:class:`DummySemaphore`), along with a reentrant lock
(:class:`RLock`) with the same API as :class:`threading.RLock`.
"""
from __future__ import absolute_import from __future__ import absolute_import
from gevent.hub import getcurrent from gevent.hub import getcurrent
......
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