Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
document the recent python examples
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Sun, 17 Mar 2019 15:33:05 +0000 (16:33 +0100)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Sun, 17 Mar 2019 18:50:52 +0000 (19:50 +0100)
examples/s4u/README.rst

index e949f9f..23a3e9c 100644 (file)
@@ -163,17 +163,24 @@ Communications on the Network
      :py:func:`simgrid.Mailbox.put_async()` :py:func:`simgrid.Comm.wait()`
 
  - **Waiting for all communications in a set:**
      :py:func:`simgrid.Mailbox.put_async()` :py:func:`simgrid.Comm.wait()`
 
  - **Waiting for all communications in a set:**
-   The :cpp:func:`simgrid::s4u::Comm::wait_all()` function is useful
-   when you want to block until all activities in a given set have
-   completed. 
-   |br| `examples/s4u/async-waitall/s4u-async-waitall.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/async-waitall/s4u-async-waitall.cpp>`_
+   The `wait_all()` function is useful when you want to block until
+   all activities in a given set have completed. 
+   
+   - |cpp| `examples/s4u/async-waitall/s4u-async-waitall.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/async-waitall/s4u-async-waitall.cpp>`_
+     :cpp:func:`simgrid::s4u::Comm::wait_all()`
+   - |py| `examples/python/async-waitall/async-waitall.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/async-waitall/async-waitall.py>`_
+     :py:func:`simgrid.Comm.wait_all()`
 
  - **Waiting for the first completed communication in a set:**
 
  - **Waiting for the first completed communication in a set:**
-   The :cpp:func:`simgrid::s4u::Comm::wait_any()` function is useful
+   The `wait_any()` function is useful
    when you want to block until one activity of the set completes, no
    when you want to block until one activity of the set completes, no
-   matter which terminates first.    
-   |br| `examples/s4u/async-waitany/s4u-async-waitany.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/async-waitany/s4u-async-waitany.cpp>`_
-
+   matter which terminates first.
+   
+   - |cpp| `examples/s4u/async-waitany/s4u-async-waitany.cpp <https://framagit.org/simgrid/simgrid/tree/master/examples/s4u/async-waitany/s4u-async-waitany.cpp>`_
+     :cpp:func:`simgrid::s4u::Comm::wait_any()`
+   - |py| `examples/python/async-waitany/async-waitany.py <https://framagit.org/simgrid/simgrid/tree/master/examples/python/async-waitany/async-waitany.py>`_
+     :py:func:`simgrid.Comm.wait_any()`
+     
 .. todo:: review the `ready` and `waituntil` examples and add them here.
    
 .. _s4u_ex_execution:
 .. todo:: review the `ready` and `waituntil` examples and add them here.
    
 .. _s4u_ex_execution: