|
1 | 1 | function Describe {
|
2 | 2 | <#
|
3 | 3 | .SYNOPSIS
|
4 |
| -Creates a logical group of tests. All Mocks and TestDrive contents |
| 4 | +Creates a logical group of tests. |
| 5 | +
|
| 6 | +.DESCRIPTION |
| 7 | +Creates a logical group of tests. All Mocks and TestDrive contents |
5 | 8 | defined within a Describe block are scoped to that Describe; they
|
6 | 9 | will no longer be present when the Describe block exits. A Describe
|
7 | 10 | block may contain any number of Context and It blocks.
|
8 | 11 |
|
9 | 12 | .PARAMETER Name
|
10 |
| -The name of the test group. This is often an expressive phrase describing the scenario being tested. |
| 13 | +The name of the test group. This is often an expressive phrase describing |
| 14 | +the scenario being tested. |
11 | 15 |
|
12 | 16 | .PARAMETER Fixture
|
13 |
| -The actual test script. If you are following the AAA pattern (Arrange-Act-Assert), this |
14 |
| -typically holds the arrange and act sections. The Asserts will also lie in this block but are |
15 |
| -typically nested each in its own It block. Assertions are typically performed by the Should |
16 |
| -command within the It blocks. |
| 17 | +The actual test script. If you are following the AAA pattern (Arrange-Act-Assert), |
| 18 | +this typically holds the arrange and act sections. The Asserts will also lie |
| 19 | +in this block but are typically nested each in its own It block. Assertions are |
| 20 | +typically performed by the Should command within the It blocks. |
17 | 21 |
|
18 | 22 | .PARAMETER Tag
|
19 |
| -Optional parameter containing an array of strings. When calling Invoke-Pester, it is possible to |
20 |
| -specify a -Tag parameter which will only execute Describe blocks containing the same Tag. |
| 23 | +Optional parameter containing an array of strings. When calling Invoke-Pester, |
| 24 | +it is possible to specify a -Tag parameter which will only execute Describe blocks |
| 25 | +containing the same Tag. |
21 | 26 |
|
22 | 27 | .EXAMPLE
|
23 | 28 | function Add-Numbers($a, $b) {
|
|
0 commit comments