Repository navigation
Document params array support with TestCaseSource - #1276
Merged
Merged
Conversation
Optional parameters and `CancellationToken` injection with `TestCaseSource` were already documented, but `params` arrays (the third feature from nunit/nunit#5057, released in 4.5) were not. Adds a short "Params arrays" section explaining how extra source arguments are gathered into the array, what happens with no extra arguments, and that an array of the right type as the last argument is passed through. Backed by a new tested snippet with all four cases. Fixes #1095 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
|
📖 Docs preview removed because this PR was closed. |
stevenaw
approved these changes
Oct 22, 2026
stevenaw
left a comment
stevenaw
left a comment
Member
There was a problem hiding this comment.
Thanks for drafting this @SeanKilleen
This looks good to me, but I'm also going to request review from @manfred-brands for secondary perspective as I think we both changed things in this area in that release
manfred-brands
requested changes
Oct 23, 2026
manfred-brands
left a comment
manfred-brands
left a comment
Member
There was a problem hiding this comment.
Could be add a note for the below?
| parameters are gathered into that array, just as they are for [TestCase](xref:attribute-testcase). A test case that | ||
| supplies no extra arguments gives an empty array, and a test case whose last argument is already an array of the right | ||
| type passes it through unchanged. (_NUnit 4.5+_) | ||
|
|
Member
There was a problem hiding this comment.
Maybe we should say something here or in the CancellationToken section below that these two don't mix.
We cannot declare a CancellationToken parameter after a params array.
Therefore if [CancelAfter] is used with a params array, the user needs to use TestContext.CurrentContext.CancellationToken instead.
Member
Author
There was a problem hiding this comment.
I think I've captured this in the latest commit. Let me know if you agree.
…ection A params array must be the last parameter, so a test method cannot also declare the CancellationToken parameter that [CancelAfter] injects. Add a note to the Params arrays section and a cross-reference in the CancellationToken section pointing to TestContext.CurrentContext.CancellationToken as the alternative, backed by a tested snippet. Addresses review feedback from @manfred-brands. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
manfred-brands
approved these changes
Oct 23, 2026
manfred-brands
left a comment
manfred-brands
left a comment
Member
There was a problem hiding this comment.
Thanks @SeanKilleen
One small change suggestion.
Co-authored-by: Manfred Brands <manfred-brands@users.noreply.github.com>
github-actions Bot
pushed a commit
that referenced
this pull request
Oct 23, 2026
* Document params array support with TestCaseSource Optional parameters and `CancellationToken` injection with `TestCaseSource` were already documented, but `params` arrays (the third feature from nunit/nunit#5057, released in 4.5) were not. Adds a short "Params arrays" section explaining how extra source arguments are gathered into the array, what happens with no extra arguments, and that an array of the right type as the last argument is passed through. Backed by a new tested snippet with all four cases. Fixes #1095 Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * Note that params arrays cannot be combined with CancellationToken injection A params array must be the last parameter, so a test method cannot also declare the CancellationToken parameter that [CancelAfter] injects. Add a note to the Params arrays section and a cross-reference in the CancellationToken section pointing to TestContext.CurrentContext.CancellationToken as the alternative, backed by a tested snippet. Addresses review feedback from @manfred-brands. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * Update docs/snippets/Snippets.NUnit/TestCaseSourceExamples.cs Co-authored-by: Manfred Brands <manfred-brands@users.noreply.github.com> --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com> Co-authored-by: Manfred Brands <manfred-brands@users.noreply.github.com> 3a359db
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Optional parameters and
CancellationTokeninjection withTestCaseSourcewere already documented, butparamsarrays (the third feature from nunit/nunit#5057, released in 4.5) were not. Adds a short "Params arrays" section explaining how extra source arguments are gathered into the array, what happens with no extra arguments, and that an array of the right type as the last argument is passed through. Backed by a new tested snippet with all four cases.Fixes #1095
🤖 Generated with Claude Code