Skip to content

Commit

Permalink
Separate Coordination section in API docs (#5412)
Browse files Browse the repository at this point in the history
  • Loading branch information
gjoseph92 committed Dec 3, 2021
1 parent a44e9de commit e2e2dda
Showing 1 changed file with 20 additions and 14 deletions.
34 changes: 20 additions & 14 deletions docs/source/api.rst
Expand Up @@ -40,14 +40,15 @@ API
.. autoautosummary:: distributed.Future
:methods:

**Client Coordination**
**Synchronization**

.. currentmodule:: distributed

.. autosummary::
Event
Lock
MultiLock
Semaphore
Queue
Variable

Expand Down Expand Up @@ -122,6 +123,24 @@ Future
.. autoclass:: Future
:members:


Synchronization
---------------

.. autoclass:: Event
:members:
.. autoclass:: Lock
:members:
.. autoclass:: MultiLock
:members:
.. autoclass:: Semaphore
:members:
.. autoclass:: Queue
:members:
.. autoclass:: Variable
:members:


Cluster
-------

Expand Down Expand Up @@ -168,19 +187,6 @@ Other
.. autoclass:: get_task_metadata
.. autoclass:: performance_report

.. autoclass:: Event
:members:
.. autoclass:: Lock
:members:
.. autoclass:: MultiLock
:members:
.. autoclass:: Semaphore
:members:
.. autoclass:: Queue
:members:
.. autoclass:: Variable
:members:


Utilities
---------
Expand Down

0 comments on commit e2e2dda

Please sign in to comment.