From 5f421ce46b1cab3acd25c8a05ea67c5be9788f76 Mon Sep 17 00:00:00 2001
From: Michael Davidsaver <mdavidsaver@gmail.com>
Date: Mon, 27 Jul 2020 08:48:50 -0700
Subject: [PATCH] doc

---
 src/pvxs/client.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/pvxs/client.h b/src/pvxs/client.h
index d7a9473..a9f6898 100644
--- a/src/pvxs/client.h
+++ b/src/pvxs/client.h
@@ -375,6 +375,23 @@ public:
     RequestBuilder request();
 
     /** Request prompt search of any disconnected channels.
+     *
+     * This method is recommended for use when executing a batch of operations.
+     *
+     * @code
+     * Context ctxt = ...;
+     * std::vector<std::string> pvnames = ...;
+     * std::vector<Operation> ops(pvnames.size());
+     *
+     * // Initiate all operations
+     * for(size_t i=0; i<pvname.size(); i++)
+     *     ops[i] = ctxt.get(pvnames[i]).exec();
+     *
+     * ctxt.hurryUp(); // indicate end of batch
+     *
+     * for(size_t i=0; i<pvname.size(); i++)
+     *     ... = ops[i].wait(); // wait for results
+     * @endcode
      *
      * Optional.  Equivalent to detection of a new server.
      * This method has no effect if called more often than once per 30 seconds.