Skip to content

Update v5 docs to Pester v5.6.1 #328

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/Add-ShouldOperator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Register a Should Operator with Pester

```powershell
Add-ShouldOperator [-Name] <String> [-Test] <ScriptBlock> [[-Alias] <String[]>] [[-InternalName] <String>]
[-SupportsArrayInput] [<CommonParameters>]
[-SupportsArrayInput] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -150,6 +150,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -166,4 +182,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/AfterAll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Context or Describe block.
## SYNTAX

```powershell
AfterAll [-Scriptblock] <ScriptBlock> [<CommonParameters>]
AfterAll [-Scriptblock] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -89,6 +89,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -107,4 +123,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/AfterEach.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ the current Context or Describe block.
## SYNTAX

```powershell
AfterEach [-Scriptblock] <ScriptBlock> [<CommonParameters>]
AfterEach [-Scriptblock] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -86,6 +86,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -104,4 +120,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
23 changes: 20 additions & 3 deletions versioned_docs/version-v5/commands/Assert-MockCalled.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,15 @@ USE Should -Invoke INSTEAD.

```powershell
Assert-MockCalled [-CommandName] <String> [[-Times] <Int32>] [-ParameterFilter <ScriptBlock>]
[-ModuleName <String>] [-Scope <String>] [-Exactly] [<CommonParameters>]
[-ModuleName <String>] [-Scope <String>] [-Exactly] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### ExclusiveFilter

```powershell
Assert-MockCalled [-CommandName] <String> [[-Times] <Int32>] [-ParameterFilter <ScriptBlock>]
-ExclusiveFilter <ScriptBlock> [-ModuleName <String>] [-Scope <String>] [-Exactly] [<CommonParameters>]
-ExclusiveFilter <ScriptBlock> [-ModuleName <String>] [-Scope <String>] [-Exactly]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -168,6 +169,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -184,4 +201,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/Assert-VerifiableMock.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ USE Should -InvokeVerifiable INSTEAD.
## SYNTAX

```powershell
Assert-VerifiableMock [<CommonParameters>]
Assert-VerifiableMock [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -45,6 +45,22 @@ PS C:\> {{ Add example code here }}

## PARAMETERS

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -61,4 +77,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/BeforeAll.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Context or Describe block.
## SYNTAX

```powershell
BeforeAll [-Scriptblock] <ScriptBlock> [<CommonParameters>]
BeforeAll [-Scriptblock] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -98,6 +98,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -116,4 +132,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/BeforeDiscovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Runs setup code that is used during Discovery phase.
## SYNTAX

```powershell
BeforeDiscovery [-ScriptBlock] <ScriptBlock> [<CommonParameters>]
BeforeDiscovery [-ScriptBlock] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -76,6 +76,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -94,4 +110,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/BeforeEach.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ the current Context or Describe block.
## SYNTAX

```powershell
BeforeEach [-Scriptblock] <ScriptBlock> [<CommonParameters>]
BeforeEach [-Scriptblock] <ScriptBlock> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -83,6 +83,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -101,4 +117,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/Context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Provides logical grouping of It blocks within a single Describe block.

```powershell
Context [-Name] <String> [-Tag <String[]>] [[-Fixture] <ScriptBlock>] [-Skip] [-ForEach <Object>]
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -161,6 +161,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -183,4 +199,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
20 changes: 18 additions & 2 deletions versioned_docs/version-v5/commands/ConvertTo-JUnitReport.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Converts a Pester result-object to an JUnit-compatible XML report
## SYNTAX

```powershell
ConvertTo-JUnitReport [-Result] <Run> [-AsString] [<CommonParameters>]
ConvertTo-JUnitReport [-Result] <Run> [-AsString] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -100,6 +100,22 @@ Accept pipeline input: False
Accept wildcard characters: False
```

### -ProgressAction

\{\{ Fill ProgressAction Description \}\}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand All @@ -118,4 +134,4 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable

## VERSION

*This page was generated using comment-based help in [Pester 5.6.0](https://github.com/pester/pester).*
*This page was generated using comment-based help in [Pester 5.6.1](https://github.com/pester/pester).*
Loading