Skip to content

Commit

Permalink
SqlServerDsc: Fix documentation (#107)
Browse files Browse the repository at this point in the history
- `Assert-BoundParameter`
  - Fixed example in documentation that were referencing an invalid command name.
  • Loading branch information
johlju authored May 9, 2023
1 parent 321951f commit 340605e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed

- `Assert-BoundParameter`
- Fixed example in documentation that were referencing an invalid command name.

## [0.16.0] - 2023-04-10

### Added
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,15 +88,15 @@ the parameters `Parameter1` and `Parameter2`.

<!-- markdownlint-disable MD013 - Line length -->
```powershell
Assert-RequiredCommandParameter -BoundParameterList $PSBoundParameters -RequiredParameter @('PBStartPortRange', 'PBEndPortRange')
Assert-BoundParameter -BoundParameterList $PSBoundParameters -RequiredParameter @('PBStartPortRange', 'PBEndPortRange')
```
<!-- markdownlint-enable MD013 - Line length -->

Throws an exception if either of the two parameters are not specified.

<!-- markdownlint-disable MD013 - Line length -->
```powershell
Assert-RequiredCommandParameter -BoundParameterList $PSBoundParameters -RequiredParameter @('Property2', 'Property3') -IfParameterPresent @('Property1')
Assert-BoundParameter -BoundParameterList $PSBoundParameters -RequiredParameter @('Property2', 'Property3') -IfParameterPresent @('Property1')
```
<!-- markdownlint-enable MD013 - Line length -->

Expand Down

0 comments on commit 340605e

Please sign in to comment.