bazel_execution_client.test.cpp: add a comment to explain the meaning of the boolean "wait"

1 files changed, 3 insertions, 0 deletions

diff --git a/test/buildtool/execution_api/bazel/bazel_execution_client.test.cpp b/test/buildtool/execution_api/bazel/bazel_execution_client.test.cpp
index e7df319b..4594de8e 100644
--- a/test/buildtool/execution_api/bazel/bazel_execution_client.test.cpp
+++ b/test/buildtool/execution_api/bazel/bazel_execution_client.test.cpp
@@ -93,6 +93,9 @@ TEST_CASE("Bazel internals: Execution Client", "[execution_api]") {
         }
 
         SECTION("Non-blocking, obtain result later") {
+            // note that the boolean false means do not wait for the stream to
+            // become available, and it has nothing to do with waiting until the
+            // action completes. This is WaitExecution's job :)
             auto response = execution_client.Execute(
                 instance_name, *action_delayed, config, false);