edit docs

Author: gottadiveintopython

sphinx/box.rst

@@ -0,0 +1,8 @@
+===
+Box
+===
+
+.. automodule:: asyncgui_ext.synctools.box
+    :members:
+    :undoc-members:
+    :exclude-members:

sphinx/event.rst

@@ -0,0 +1,8 @@
+=====
+Event
+=====
+
+.. automodule:: asyncgui_ext.synctools.event
+    :members:
+    :undoc-members:
+    :exclude-members:

sphinx/index.rst

@@ -7,4 +7,6 @@ Inter-task sychronization and communication.
 .. toctree::
    :hidden:
 
-   reference
+   box
+   event
+   queue

sphinx/queue.rst

@@ -0,0 +1,8 @@
+=====
+Queue
+=====
+
+.. automodule:: asyncgui_ext.synctools.queue
+    :members:
+    :undoc-members:
+    :exclude-members:

sphinx/reference.rst

@@ -1,34 +1,34 @@
-__all__ = ('Box', )
-import types
-
+'''
+.. code-block::
 
-class Box:
-    '''
-    Similar to :class:`asyncgui.AsyncBox`, but this one can handle multiple tasks simultaneously.
-    This is the closest thing to :class:`asyncio.Event` in this library.
-
-    .. code-block::
+    import asyncgui as ag
+    from asyncgui_ext.synctools.box import Box
 
-        async def async_fn(b1, b2):
-            args, kwargs = await b1.get()
+    async def async_fn1(box):
+        for __ in range(10):
+            args, kwargs = await box.get()
             assert args == (1, )
             assert kwargs == {'crow': 'raven', }
 
-            args, kwargs = await b2.get()
+    async def async_fn2(box):
+        for __ in range(10):
+            args, kwargs = await box.get()
             assert args == (2, )
             assert kwargs == {'frog': 'toad', }
 
-            args, kwargs = await b1.get()
-            assert args == (1, )
-            assert kwargs == {'crow': 'raven', }
+    box = Box()
+    box.put(1, crow='raven')
+    ag.start(async_fn1(box))
+    box.update(2, frog='toad')
+    ag.start(async_fn2(box))
+'''
+
+
+__all__ = ('Box', )
+import types
 
-        b1 = Box()
-        b2 = Box()
-        b1.put(1, crow='raven')
-        start(async_fn(b1, b2))
-        b2.put(2, frog='toad')
-    '''
 
+class Box:
     __slots__ = ('_item', '_waiting_tasks', )
 
     def __init__(self):

src/asyncgui_ext/synctools/box.py

@@ -1,29 +1,35 @@
-__all__ = ('Event', )
-import types
+'''
+.. code-block::
 
+    import asyncgui as ag
+    from asyncgui_ext.synctools.event import Event
 
-class Event:
-    '''
-    Similar to :class:`asyncgui.AsyncEvent`, but this one can handle multiple tasks simultaneously.
+    async def async_fn1(e):
+        args, kwargs = await e.wait()
+        assert args == (1, )
+        assert kwargs == {'crow': 'raven', }
 
-    .. code-block::
+        args, kwargs = await e.wait()
+        assert args == (2, )
+        assert kwargs == {'toad': 'frog', }
 
-        async def async_fn(e):
-            args, kwargs = await e.wait()
-            assert args == (2, )
-            assert kwargs == {'crow': 'raven', }
+    async def async_fn2(e):
+        args, kwargs = await e.wait()
+        assert args == (2, )
+        assert kwargs == {'toad': 'frog', }
 
-            args, kwargs = await e.wait()
-            assert args == (3, )
-            assert kwargs == {'toad': 'frog', }
+    e = Event()
+    ag.start(async_fn1(e))
+    e.fire(1, crow='raven')
+    ag.start(async_fn2(e))
+    e.fire(2, toad='frog')
+'''
+
+__all__ = ('Event', )
+import types
 
-        e = Event()
-        e.fire(1, crocodile='alligator')
-        start(async_fn(e))
-        e.fire(2, crow='raven')
-        e.fire(3, toad='frog')
-    '''
 
+class Event:
     __slots__ = ('_waiting_tasks', )
 
     def __init__(self):