Fix exception handling api doc (apache#13519)

* Fix exception handling api doc * Update waitall api doc Co-Authored-By: anirudh2290 <[email protected]>
zhaoyao73 · Dec 9, 2018 · 2266d87 · 2266d87
1 parent 274a496
commit 2266d87
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py
@@ -157,6 +157,11 @@ def waitall():
     """Wait for all async operations to finish in MXNet.
 
     This function is used for benchmarking only.
+    .. warning::
+    If your code has exceptions, `waitall` can cause silent failures.
+    For this reason you should avoid `waitall` in your code.
+    Use it only if you are confident that your code is error free.
+    Then make sure you call `wait_to_read` on all outputs after `waitall`.
     """
     check_call(_LIB.MXNDArrayWaitAll())