Clarification on max attempts meaning (#596)

Author: slinkydeveloper

packages/restate-sdk/src/context.ts

@@ -171,7 +171,7 @@ export type RunOptions<T> = {
   serde?: Serde<T>;
 
   /**
-   * Max number of retry attempts, before giving up.
+   * Max number of attempts (including the initial), before giving up.
    *
    * When giving up, `ctx.run` will throw a `TerminalError` wrapping the original error message.
    */

packages/restate-sdk/src/types/rpc.ts

@@ -759,7 +759,8 @@ export type ServiceOpts<U> = {
 
 export type RetryPolicy = {
   /**
-   * Max number of retry attempts. When reached, the behavior specified in {@link onMaxAttempts} will be applied.
+   * Max number of retry attempts (including the initial).
+   * When reached, the behavior specified in {@link onMaxAttempts} will be applied.
    */
   maxAttempts?: number;