Skip to content

Commit 9870c5c

Browse files
Fix incorrect case/capitalization in ref docs
This ensures the following components have the correct/consistent case throughout the reference documentation: Preference variable, PS environment variable, PS drive, PS provider, PS command name, PS command argument, PS module, PS file extension, PS host name/application, #Requires statement, parameter name, about_* topic, member name, scope modifier, keyword, operator, calculated property key/value, attribute, type accelerator, type literal/name, WMI namespace/class, variable name, special character, comment-based help keyword, product/company name, Windows drive letter/directory, Windows/Unix environment variable In addition, changes include fixes to incorrect terminology (e.g., referring to a keyword as a command) and formatting of PS syntax elements (non-exhaustive).
1 parent 683ebdf commit 9870c5c

40 files changed

+219
-218
lines changed

reference/5.1/Microsoft.PowerShell.Management/Remove-WmiObject.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ The `Remove-WmiObject` cmdlet deletes an instance of an existing Windows Managem
7777

7878
```powershell
7979
notepad
80-
$np = Get-WmiObject -Query "select * from win32_process where name='notepad.exe'"
80+
$np = Get-WmiObject -Query "select * from Win32_Process where name='notepad.exe'"
8181
$np | Remove-WmiObject
8282
```
8383

@@ -96,14 +96,14 @@ instances of Notepad.exe.
9696
This command deletes the C:\Test folder.
9797

9898
```powershell
99-
$a = Get-WMIObject -Query "Select * From Win32_Directory Where Name ='C:\\Test'"
100-
$a | Remove-WMIObject
99+
$a = Get-WmiObject -Query "Select * From Win32_Directory Where Name ='C:\\Test'"
100+
$a | Remove-WmiObject
101101
```
102102

103-
The first command uses `Get-WMIObject` to query for the `C:\Test` folder, and then stores the object
103+
The first command uses `Get-WmiObject` to query for the `C:\Test` folder, and then stores the object
104104
in the `$a` variable.
105105

106-
The second command pipes the `$a` variable to `Remove-WMIObject`, which deletes the folder.
106+
The second command pipes the `$a` variable to `Remove-WmiObject`, which deletes the folder.
107107

108108
## PARAMETERS
109109

reference/5.1/Microsoft.PowerShell.Management/Reset-ComputerMachinePassword.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ password in the domain.
5151

5252
```powershell
5353
$cred = Get-Credential
54-
Invoke-Command -ComputerName "Server01" -ScriptBlock {Reset-ComputerMachinePassword -Credential $using:cred}
54+
Invoke-Command -ComputerName "Server01" -ScriptBlock {Reset-ComputerMachinePassword -Credential $Using:cred}
5555
```
5656

5757
This command uses the Invoke-Command cmdlet to run a `Reset-ComputerMachinePassword` command on the

reference/5.1/Microsoft.PowerShell.Management/Set-WmiInstance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ reflects the new value.
137137

138138
```powershell
139139
$setWmiInstanceSplat = @{
140-
Class = 'win32_environment'
140+
Class = 'Win32_Environment'
141141
Arguments = @{
142142
Name="testvar"
143143
VariableValue="testvalue"

reference/5.1/Microsoft.PowerShell.Management/Show-ControlPanelItem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ This method is an alternative to using a `Show-ControlPanelItem` command.
8080

8181
> [!NOTE]
8282
> In PowerShell, you can omit the .cpl file extension for control panel files because it's included
83-
> in the value of the `$env:PathExt` environment variable.
83+
> in the value of the `$Env:PATHEXT` environment variable.
8484
8585
## PARAMETERS
8686

reference/5.1/Microsoft.PowerShell.Management/Start-Transaction.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Windows PowerShell. For more information, see [about_Transactions](../Microsoft.
5252
### Example 1: Start and roll back a transaction
5353

5454
```powershell
55-
Set-Location hkcu:\software
55+
Set-Location HKCU:\software
5656
Start-Transaction
5757
New-Item "ContosoCompany" -UseTransaction
5858
New-ItemProperty "ContosoCompany" -Name "MyKey" -Value 123 -UseTransaction
@@ -65,7 +65,7 @@ changes are made to the registry.
6565
### Example 2: Start and complete a transaction
6666

6767
```powershell
68-
Set-Location hkcu:\software
68+
Set-Location HKCU:\software
6969
Start-Transaction
7070
New-Item "ContosoCompany" -UseTransaction
7171
New-ItemProperty "ContosoCompany" -Name "MyKey" -Value 123 -UseTransaction
@@ -82,11 +82,11 @@ Set-Location HKCU:\software
8282
Start-Transaction
8383
New-Item -Path "NoPath" -Name "ContosoCompany" -UseTransaction
8484
New-Item -Path . -Name "ContosoCompany" -UseTransaction
85-
Start-Transaction -RollbackPreference never
85+
Start-Transaction -RollbackPreference Never
8686
New-Item -Path "NoPath" -Name "ContosoCompany" -UseTransaction
8787
New-Item -Path . -Name "ContosoCompany" -UseTransaction
8888
89-
# Start-Transaction (-rollbackpreference error)
89+
# Start-Transaction (-RollbackPreference Error)
9090
9191
Start-Transaction
9292
New-Item -Path "NoPath" -Name "ContosoCompany" -UseTransaction
@@ -95,7 +95,7 @@ New-Item : The registry key at the specified path does not exist.
9595

9696
```Output
9797
At line:1 char:9
98-
+ new-item <<<< -Path NoPath -Name ContosoCompany -UseTransaction
98+
+ New-Item <<<< -Path NoPath -Name ContosoCompany -UseTransaction
9999
```
100100

101101
```powershell
@@ -109,9 +109,9 @@ At line:1 char:9
109109
```
110110

111111
```powershell
112-
# Start-Transaction (-rollbackpreference never)
112+
# Start-Transaction (-RollbackPreference Never)
113113
114-
Start-Transaction -RollbackPreference never
114+
Start-Transaction -RollbackPreference Never
115115
New-Item -Path "NoPath" -Name "ContosoCompany" -UseTransaction
116116
```
117117

@@ -235,7 +235,7 @@ As a result, the registry is changed.
235235
### Example 6: Run commands that are not part of a transaction
236236

237237
```powershell
238-
Set-Location hkcu:\software
238+
Set-Location HKCU:\software
239239
Start-Transaction
240240
New-Item "ContosoCompany1" -UseTransaction
241241
New-Item "ContosoCompany2"
@@ -308,7 +308,7 @@ New-Item HKCU:\Software\ContosoCompany -UseTransaction
308308
```Output
309309
New-Item : Cannot use transaction. The transaction has been rolled back or has timed out.
310310
At line:1 char:9
311-
+ new-item <<<< MyCompany -UseTransaction
311+
+ New-Item <<<< MyCompany -UseTransaction
312312
```
313313

314314
This command uses the **Timeout** parameter of `Start-Transaction` to start a transaction that must

reference/5.1/Microsoft.PowerShell.Management/Test-Connection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ multiple connections, it returns an array of **Boolean** values.
493493

494494
## NOTES
495495

496-
This cmdlet uses the **Win32_PingStatus** class. A `Get-WMIObject Win32_PingStatus` command is
496+
This cmdlet uses the **Win32_PingStatus** class. A `Get-WmiObject Win32_PingStatus` command is
497497
equivalent to a `Test-Connection` command.
498498

499499
The **Source** parameter set was introduced in PowerShell 3.0.

reference/5.1/Microsoft.PowerShell.Management/Undo-Transaction.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This command rolls back the current, active, transaction.
4848
### Example 2: Start and roll back a transaction
4949

5050
```powershell
51-
Set-Location hkcu:\software
51+
Set-Location HKCU:\software
5252
Start-Transaction
5353
New-Item -Path "ContosoCompany" -UseTransaction
5454
Undo-Transaction
@@ -60,7 +60,7 @@ registry.
6060
### Example 3: Roll back a transaction for all subscribers
6161

6262
```powershell
63-
Set-Location hkcu:\software
63+
Set-Location HKCU:\software
6464
Start-Transaction
6565
New-Item -Path "ContosoCompany" -UseTransaction
6666
Get-Transaction

reference/5.1/Microsoft.PowerShell.Management/Use-Transaction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ Accept wildcard characters: False
162162
### -UseTransaction
163163
164164
Includes the command in the active transaction. This parameter is valid only when a transaction is
165-
in progress. For more information, see [about_transactions](../Microsoft.PowerShell.Core/About/about_Transactions.md).
165+
in progress. For more information, see [about_Transactions](../Microsoft.PowerShell.Core/About/about_Transactions.md).
166166
167167
```yaml
168168
Type: System.Management.Automation.SwitchParameter

reference/5.1/Microsoft.PowerShell.Utility/ConvertFrom-String.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ Wild Shrimp, (111) 222-3333, 1
156156
'@
157157
158158
$PersonalData = $testText | ConvertFrom-String -TemplateContent $template
159-
Write-output ("Pet items found: " + ($PersonalData.Count))
159+
Write-Output ("Pet items found: " + ($PersonalData.Count))
160160
$PersonalData
161161
```
162162

@@ -206,7 +206,7 @@ Wild Shrimp, (111) 222-3333, 1
206206
'@
207207
208208
$PersonalData = $testText | ConvertFrom-String -TemplateContent $template
209-
Write-output ("Pet items found: " + ($PersonalData.Count))
209+
Write-Output ("Pet items found: " + ($PersonalData.Count))
210210
$PersonalData
211211
```
212212

reference/5.1/PSReadLine/Get-PSReadLineOption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: Microsoft.PowerShell.PSReadLine2.dll-Help.xml
33
Locale: en-US
4-
Module Name: PSReadline
4+
Module Name: PSReadLine
55
ms.date: 12/13/2022
66
online version: https://learn.microsoft.com/powershell/module/psreadline/get-psreadlineoption?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0

0 commit comments

Comments
 (0)