Clarify that .retry is user-defined (#1347)

* Clarify that `.retry` is user-defined * Use jsDoc comment instead (consistency with #1064)
GoogleCloudPlatform · Jun 7, 2019 · 6dee350 · 6dee350
1 parent 6e57071
commit 6dee350
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/functions/node8/index.js b/functions/node8/index.js
@@ -65,6 +65,7 @@ exports.avoidInfiniteRetries = (data, context) => {
  * how to toggle retries using a promise
  *
  * @param {object} data The event payload.
+ * @param {object} data.retry User-supplied parameter that tells the function whether to retry.
  * @param {object} context The event metadata.
  */
 exports.retryPromise = (data, context) => {