Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing help for -Skip in Context and Describe #2426

Merged
merged 2 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/functions/Context.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
Script that is executed. This may include setup specific to the context
and one or more It blocks that validate the expected outcomes.

.PARAMETER Skip
Use this parameter to explicitly mark the block to be skipped. This is preferable to temporarily
commenting out a block, because it remains listed in the output.

.PARAMETER ForEach
Allows data driven tests to be written.
Takes an array of data and generates one block for each item in the array, and makes the item
Expand Down
4 changes: 4 additions & 0 deletions src/functions/Describe.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
it is possible to specify a -Tag parameter which will only execute Describe blocks
containing the same Tag.

.PARAMETER Skip
Use this parameter to explicitly mark the block to be skipped. This is preferable to temporarily
commenting out a block, because it remains listed in the output.

.PARAMETER ForEach
Allows data driven tests to be written.
Takes an array of data and generates one block for each item in the array, and makes the item
Expand Down
3 changes: 1 addition & 2 deletions src/functions/It.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@

.PARAMETER Skip
Use this parameter to explicitly mark the test to be skipped. This is preferable to temporarily
commenting out a test, because the test remains listed in the output. Use the Strict parameter
of Invoke-Pester to force all skipped tests to fail.
commenting out a test, because the test remains listed in the output.

.PARAMETER ForEach
(Formerly called TestCases.) Optional array of hashtable (or any IDictionary) objects.
Expand Down