Document per-func actors for clarity

README.rst

@@ -267,12 +267,14 @@ actor and print the results to your screen:
     import tractor
 
 
+    # this is the first 2 actors, streamer_1 and streamer_2
     async def stream_data(seed):
         for i in range(seed):
             yield i
             await trio.sleep(0)  # trigger scheduler
 
 
+    # this is the third actor; the aggregator
     async def aggregate(seed):
         """Ensure that the two streams we receive match but only stream
         a single set of values to the parent.
@@ -325,6 +327,7 @@ actor and print the results to your screen:
         print("AGGREGATOR COMPLETE!")
 
 
+    # this is the main actor and *arbiter*
     async def main():
         # a nursery which spawns "actors"
         async with tractor.open_nursery() as nursery:

tests/test_tractor.py

@@ -358,12 +358,14 @@ async def main():
     tractor.run(main, arbiter_addr=_arb_addr)
 
 
+# this is the first 2 actors, streamer_1 and streamer_2
 async def stream_data(seed):
     for i in range(seed):
         yield i
         await trio.sleep(0)  # trigger scheduler
 
 
+# this is the third actor; the aggregator
 async def aggregate(seed):
     """Ensure that the two streams we receive match but only stream
     a single set of values to the parent.
@@ -416,7 +418,7 @@ async def push_to_q(portal):
     print("AGGREGATOR COMPLETE!")
 
 
-# @tractor_test
+# this is the main actor and *arbiter*
 async def a_quadruple_example():
     # a nursery which spawns "actors"
     async with tractor.open_nursery() as nursery: