[aws-api] improve docstrings

Port 7d07cb796eaa06a229290be92e92d18ee3448830 from aws-api
grzm · Nov 12, 2023 · 849d133 · 849d133
1 parent 528474f
commit 849d133
Showing 1 changed file with 4 additions and 6 deletions.
diff --git a/src/com/grzm/awyeah/client/api.clj b/src/com/grzm/awyeah/client/api.clj
@@ -110,7 +110,7 @@
   (http/resolve-http-client nil))
 
 (defn invoke
-  "Package and send a request to AWS and return the result.
+  "Packages and sends a request to AWS and returns the result.
 
   Supported keys in op-map:
 
@@ -121,15 +121,14 @@
   :backoff              - optional, defaults to :backoff on the client.
                           See client.
 
-  After invoking (com.grzm.awyeah.client.api/validate-requests true), validates
-  :request in op-map.
+  Will validate :request after calling (validate-requests client true).
 
   Alpha. Subject to change."
   [client op-map]
   (client.protocol/-invoke client op-map))
 
 (defn invoke-async
-  "Package and send a request to AWS and return a channel which
+  "Packages and sends a request to AWS and returns a channel which
   will contain the result.
 
   Supported keys in op-map:
@@ -142,8 +141,7 @@
   :backoff              - optional, defaults to :backoff on the client.
                           See client.
 
-  After invoking (com.grzm.awyeah.client.api/validate-requests true), validates
-  :request in op-map.
+  Will validate :request after calling (validate-requests client true).
 
   Alpha. Subject to change."
   [client op-map]