Skip to content

Commit c824f88

Browse files
committed
Refactor parameter descriptions across multiple scripts for clarity and consistency
1 parent ab5a2dd commit c824f88

File tree

5 files changed

+16
-15
lines changed

5 files changed

+16
-15
lines changed

source/Public/Install-SqlDscBIReportServer.ps1

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
Installs SQL Server Power BI Report Server using the provided setup executable.
77
88
.PARAMETER AcceptLicensingTerms
9-
Required parameter to be able to run unattended install. By specifying this
9+
Specifies that the acceptance of all license terms and notices for the
10+
specified features is required to be able to run unattended install. By specifying this
1011
parameter you acknowledge the acceptance of all license terms and notices for
1112
the specified features, the terms and notices that the setup executable
1213
normally asks for.
@@ -20,7 +21,7 @@
2021
This parameter is mutually exclusive with the parameter Edition.
2122
2223
.PARAMETER EditionUpgrade
23-
Upgrades the edition of the installed product. Requires that either the
24+
Specifies whether to upgrade the edition of the installed product. Requires that either the
2425
ProductKey or the Edition parameter is also assigned. By default no edition
2526
upgrade is performed.
2627
@@ -40,7 +41,7 @@
4041
PI Report Server: %ProgramFiles%\Microsoft Power BI Report Server
4142
4243
.PARAMETER SuppressRestart
43-
Suppresses the restart of the computer after the installation is finished.
44+
Specifies whether to suppress the restart of the computer after the installation is finished.
4445
By default the computer is restarted after the installation is finished.
4546
4647
.PARAMETER Timeout
@@ -49,11 +50,11 @@
4950
this time, an exception will be thrown.
5051
5152
.PARAMETER Force
52-
If specified the command will not ask for confirmation. Same as if Confirm:$false
53+
Specifies whether the command will not ask for confirmation. Same as if Confirm:$false
5354
is used.
5455
5556
.PARAMETER PassThru
56-
If specified the command will return the setup process exit code.
57+
Specifies whether the command will return the setup process exit code.
5758
5859
.OUTPUTS
5960
When PassThru is specified the function will return the setup process exit

source/Public/Invoke-SqlDscQuery.ps1

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,21 @@
2929
Specifies the name of the database to execute the T-SQL query in.
3030
3131
.PARAMETER Query
32-
The query string to execute.
32+
Specifies the query string to execute.
3333
3434
.PARAMETER PassThru
35-
Specifies if the command should return any result the query might return.
35+
Specifies whether the command should return any result the query might return.
3636
3737
.PARAMETER StatementTimeout
38-
Set the query StatementTimeout in seconds. Default 600 seconds (10 minutes).
38+
Specifies the query StatementTimeout in seconds. Default 600 seconds (10 minutes).
3939
4040
.PARAMETER RedactText
41-
One or more text strings to redact from the query when verbose messages
41+
Specifies one or more text strings to redact from the query when verbose messages
4242
are written to the console. Strings will be escaped so they will not
4343
be interpreted as regular expressions (RegEx).
4444
4545
.PARAMETER Encrypt
46-
Specifies if encryption should be used.
46+
Specifies whether encryption should be used.
4747
4848
.PARAMETER Force
4949
Specifies that the query should be executed without any confirmation.

source/Public/New-SqlDscAgentOperator.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
Specifies the weekday pager start time for the SQL Agent Operator.
4646
4747
.PARAMETER PassThru
48-
If specified, the created operator object will be returned.
48+
Specifies whether the created operator object will be returned.
4949
5050
.PARAMETER Force
5151
Specifies that the operator should be created without any confirmation.

source/Public/Set-SqlDscAgentAlert.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
Cannot be used together with Severity.
2525
2626
.PARAMETER PassThru
27-
If specified, the updated alert object will be returned.
27+
Specifies whether the updated alert object will be returned.
2828
2929
.PARAMETER Refresh
3030
Specifies that the alert object should be refreshed before updating. This

source/Public/Uninstall-SqlDscReportingService.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
By default log files are created under %TEMP%.
1616
1717
.PARAMETER SuppressRestart
18-
Suppresses the restart of the computer after the uninstallation is finished.
18+
Specifies whether to suppress the restart of the computer after the uninstallation is finished.
1919
By default the computer is restarted after the uninstallation is finished.
2020
2121
.PARAMETER Timeout
@@ -24,11 +24,11 @@
2424
this time, an exception will be thrown.
2525
2626
.PARAMETER Force
27-
If specified the command will not ask for confirmation. Same as if Confirm:$false
27+
Specifies whether the command will not ask for confirmation. Same as if Confirm:$false
2828
is used.
2929
3030
.PARAMETER PassThru
31-
If specified the command will return the setup process exit code.
31+
Specifies whether the command will return the setup process exit code.
3232
3333
.OUTPUTS
3434
When PassThru is specified the function will return the setup process exit

0 commit comments

Comments
 (0)