Extend snippet explanation

Extend explanation about how the state is captured. See #2290 (comment).
App-vNext · Nov 11, 2024 · 7567acc · 7567acc
1 parent 607535c
commit 7567acc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/advanced/performance.md b/docs/advanced/performance.md
@@ -37,9 +37,10 @@ await resiliencePipeline.ExecuteAsync(
     cancellationToken);
 
 // This approach uses a static lambda, avoiding allocations.
-// The "userId" is stored as state, and the lambda consumes it.
+// The "userId" is passed to the execution via the state argument, and the lambda consumes it as the first
+// parameter passed to the GetMemberAsync() method. In this case, userIdAsState and userId are the same value.
 await resiliencePipeline.ExecuteAsync(
-    static (state, cancellationToken) => GetMemberAsync(state, cancellationToken),
+    static (userIdAsState, cancellationToken) => GetMemberAsync(userIdAsState, cancellationToken),
     userId,
     cancellationToken);
 ```

diff --git a/src/Snippets/Docs/Performance.cs b/src/Snippets/Docs/Performance.cs
@@ -22,9 +22,10 @@ await resiliencePipeline.ExecuteAsync(
             cancellationToken);
 
         // This approach uses a static lambda, avoiding allocations.
-        // The "userId" is stored as state, and the lambda consumes it.
+        // The "userId" is passed to the execution via the state argument, and the lambda consumes it as the first
+        // parameter passed to the GetMemberAsync() method. In this case, userIdAsState and userId are the same value.
         await resiliencePipeline.ExecuteAsync(
-            static (state, cancellationToken) => GetMemberAsync(state, cancellationToken),
+            static (userIdAsState, cancellationToken) => GetMemberAsync(userIdAsState, cancellationToken),
             userId,
             cancellationToken);