From 3897af180ff4f733c363af562a67694ced1b833f Mon Sep 17 00:00:00 2001 From: Anirudh Subramanian Date: Tue, 11 Dec 2018 21:23:00 +0000 Subject: [PATCH] Fix warning in waitall doc --- python/mxnet/ndarray/ndarray.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/python/mxnet/ndarray/ndarray.py b/python/mxnet/ndarray/ndarray.py index 4e6d0cdc929f..9a62620da85c 100644 --- a/python/mxnet/ndarray/ndarray.py +++ b/python/mxnet/ndarray/ndarray.py @@ -157,11 +157,13 @@ 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`. + + 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())