Skip to content

Commit 88e7000

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 88e7000

40 files changed

+110
-110
lines changed

reference/5.1/Microsoft.PowerShell.Management/New-PSDrive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ Get-PSDrive -Name "PSDrive", "X"
205205
Name Provider Root
206206
---- -------- ----
207207
208-
PsDrive FileSystem \\Server01\public
208+
PSDrive FileSystem \\Server01\public
209209
X FileSystem X:\
210210
```
211211

reference/5.1/Microsoft.PowerShell.Management/New-Service.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ object includes the start mode and the service description.
7979
```powershell
8080
sc.exe delete TestService
8181
# - or -
82-
(Get-CimInstance -Class Win32_Service -Filter "name='TestService'").delete()
82+
(Get-CimInstance -Class Win32_Service -Filter "name='TestService'").Delete()
8383
```
8484

8585
This example shows two ways to delete the TestService service. The first command uses the delete
@@ -93,11 +93,11 @@ that `Get-CimInstance` returns.
9393
Specifies the path of the executable file for the service. This parameter is required.
9494

9595
The fully qualified path to the service binary file. If the path contains a space, it must be quoted
96-
so that it is correctly interpreted. For example, `d:\my share\myservice.exe` should be specified as
97-
`'"d:\my share\myservice.exe"'`.
96+
so that it is correctly interpreted. For example, `D:\my share\myservice.exe` should be specified as
97+
`'"D:\my share\myservice.exe"'`.
9898

9999
The path can also include arguments for an auto-start service. For example,
100-
`'"d:\my share\myservice.exe" arg1 arg2'`. These arguments are passed to the service entry point.
100+
`'"D:\my share\myservice.exe" arg1 arg2'`. These arguments are passed to the service entry point.
101101

102102
For more information, see the **lpBinaryPathName** parameter of
103103
[CreateServiceW](/windows/win32/api/winsvc/nf-winsvc-createservicew) API.

reference/5.1/Microsoft.PowerShell.Management/Pop-Location.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ For more information about location stacks, see the [Notes](#notes).
5050
```
5151
PS C:\> pushd HKLM:\Software\Microsoft\PowerShell
5252
PS HKLM:\Software\Microsoft\PowerShell> pushd Cert:\LocalMachine\TrustedPublisher
53-
PS cert:\LocalMachine\TrustedPublisher> popd
53+
PS Cert:\LocalMachine\TrustedPublisher> popd
5454
PS HKLM:\Software\Microsoft\PowerShell> popd
5555
PS C:\>
5656
```
@@ -63,7 +63,7 @@ The first command pushes the current file system location onto the stack and mov
6363
supported by the PowerShell Registry provider.
6464

6565
The second command pushes the registry location onto the stack and moves to a location supported by
66-
the PowerShell certificate provider.
66+
the PowerShell Certificate provider.
6767

6868
The last two commands pop those locations off the stack. The first `popd` command returns to the
6969
Registry drive, and the second command returns to the file system drive.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ Windows PowerShell includes the following aliases for `Remove-Item`:
526526
- `rmdir`
527527

528528
The `Remove-Item` cmdlet is designed to work with the data exposed by any provider. To list the
529-
providers available in your session, type `Get-PsProvider`. For more information, see
529+
providers available in your session, type `Get-PSProvider`. For more information, see
530530
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
531531

532532
When you try to delete a folder that contains items without using the **Recurse** parameter, the

reference/5.1/Microsoft.PowerShell.Management/Rename-Item.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ name. To move and rename an item, use the `Move-Item` cmdlet.
4444
This command renames the file `daily_file.txt` to `monday_file.txt`.
4545

4646
```powershell
47-
Rename-Item -Path "c:\logfiles\daily_file.txt" -NewName "monday_file.txt"
47+
Rename-Item -Path "C:\logfiles\daily_file.txt" -NewName "monday_file.txt"
4848
```
4949

5050
### Example 2: Rename and move an item
@@ -54,15 +54,15 @@ for the value of the **NewName** parameter, unless the path is identical to the
5454
the **Path** parameter. Otherwise, only a new name is permitted.
5555

5656
```powershell
57-
Rename-Item -Path "project.txt" -NewName "d:\archive\old-project.txt"
57+
Rename-Item -Path "project.txt" -NewName "D:\archive\old-project.txt"
5858
```
5959

6060
```Output
6161
Rename-Item : can't rename because the target specified represents a path or device name.
6262
At line:1 char:12
63-
+ Rename-Item <<<< -path project.txt -NewName d:\archive\old-project.txt
63+
+ Rename-Item <<<< -Path project.txt -NewName D:\archive\old-project.txt
6464
+ CategoryInfo : InvalidArgument: (:) [Rename-Item], PS> Move-Item -Path "project.txt" -De
65-
stination "d:\archive\old-project.txt"
65+
stination "D:\archive\old-project.txt"
6666
```
6767

6868
This example attempts to rename the `project.txt` file in the current directory to `old-project.txt`
@@ -189,8 +189,8 @@ differs from the path that is specified in the **Path** parameter, `Rename-Item`
189189
To rename and move an item, use `Move-Item`.
190190

191191
You can't use wildcard characters in the value of the **NewName** parameter. To specify a name for
192-
multiple files, use the **Replace** operator in a regular expression. For more information about the
193-
Replace operator, see [about_Comparison_Operators](../Microsoft.PowerShell.Core/About/about_Comparison_Operators.md).
192+
multiple files, use the `-replace` operator in a regular expression. For more information about the
193+
`-replace` operator, see [about_Comparison_Operators](../Microsoft.PowerShell.Core/About/about_Comparison_Operators.md).
194194

195195
```yaml
196196
Type: System.String
@@ -319,7 +319,7 @@ Windows PowerShell includes the following aliases for `Rename-Item`:
319319
- `rni`
320320

321321
`Rename-Item` is designed to work with the data exposed by any provider. To list the providers
322-
available in your session, type `Get-PsProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
322+
available in your session, type `Get-PSProvider`. For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
323323

324324
## RELATED LINKS
325325

reference/5.1/Microsoft.PowerShell.Management/Resolve-Path.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ This command resolves a Universal Naming Convention (UNC) path and returns the s
8787
### Example 5: Get relative paths
8888

8989
```powershell
90-
Resolve-Path -Path "c:\prog*" -Relative
90+
Resolve-Path -Path "C:\prog*" -Relative
9191
```
9292

9393
```Output
@@ -188,7 +188,7 @@ Accept wildcard characters: False
188188
### -UseTransaction
189189
Includes the command in the active transaction.
190190
This parameter is valid only when a transaction is in progress.
191-
For more information, see [about_transactions](../Microsoft.PowerShell.Core/About/about_Transactions.md).
191+
For more information, see [about_Transactions](../Microsoft.PowerShell.Core/About/about_Transactions.md).
192192
193193
```yaml
194194
Type: System.Management.Automation.SwitchParameter
@@ -235,7 +235,7 @@ The `*-Path` cmdlets work with the **FileSystem**, **Registry**, and **Certifica
235235
236236
`Resolve-Path` is designed to work with any provider. To list the providers available in your
237237
session, type `Get-PSProvider`. For more information, see
238-
[about_providers](../microsoft.powershell.core/about/about_providers.md).
238+
[about_Providers](../microsoft.powershell.core/about/about_providers.md).
239239
240240
`Resolve-Path` only resolves existing paths. It cannot be used to resolve a location that does not
241241
exist yet.

reference/5.1/Microsoft.PowerShell.Management/Restart-Computer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ The acceptable values for this parameter are:
298298

299299
- **Default**: Waits for PowerShell to restart.
300300
- **PowerShell**: Can run commands in a PowerShell remote session on the computer.
301-
- **WMI**: Receives a reply to a Win32_ComputerSystem query for the computer.
301+
- **WMI**: Receives a reply to a **Win32_ComputerSystem** query for the computer.
302302
- **WinRM**: Can establish a remote session to the computer by using WS-Management.
303303

304304
This parameter was introduced in Windows PowerShell 3.0.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The word Warning was replaced.
125125

126126
```powershell
127127
(Get-Content -Path .\Notice.txt) |
128-
ForEach-Object {$_ -Replace 'Warning', 'Caution'} |
128+
ForEach-Object {$_ -replace 'Warning', 'Caution'} |
129129
Set-Content -Path .\Notice.txt
130130
Get-Content -Path .\Notice.txt
131131
```
@@ -506,7 +506,7 @@ Windows PowerShell includes the following aliases for `Set-Content`:
506506
- `Set-Content` is designed for string processing. If you pipe non-string objects to `Set-Content`,
507507
it converts the object to a string before writing it. To write objects to files, use `Out-File`.
508508
- The `Set-Content` cmdlet is designed to work with the data exposed by any provider. To list the
509-
providers available in your session, type `Get-PsProvider`. For more information, see
509+
providers available in your session, type `Get-PSProvider`. For more information, see
510510
[about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
511511

512512
## RELATED LINKS

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -74,23 +74,23 @@ specified in the command.
7474
This command creates an alias of np for Notepad.
7575

7676
```powershell
77-
Set-Item -Path alias:np -Value "c:\windows\notepad.exe"
77+
Set-Item -Path Alias:np -Value "C:\windows\notepad.exe"
7878
```
7979

8080
### Example 2: Change the value of an environment variable
8181

8282
This command changes the value of the UserRole environment variable to Administrator.
8383

8484
```powershell
85-
Set-Item -Path env:UserRole -Value "Administrator"
85+
Set-Item -Path Env:UserRole -Value "Administrator"
8686
```
8787

8888
### Example 3: Modify your prompt function
8989

9090
This command changes the prompt function so that it displays the time before the path.
9191

9292
```powershell
93-
Set-Item -Path function:prompt -Value {'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '}
93+
Set-Item -Path Function:prompt -Value {'PS '+ (Get-Date -Format t) + " " + (Get-Location) + '> '}
9494
```
9595

9696
### Example 4: Set options for your prompt function
@@ -101,7 +101,7 @@ The **Options** parameter is available in `Set-Item` only when you use it with t
101101
**Function** provider.
102102

103103
```powershell
104-
Set-Item -Path function:prompt -Options "AllScope,ReadOnly"
104+
Set-Item -Path Function:prompt -Options "AllScope,ReadOnly"
105105
```
106106

107107
## PARAMETERS
@@ -423,7 +423,7 @@ Windows PowerShell includes the following aliases for `Set-Item`:
423423
- To change the names and data in registry values, use the `New-ItemProperty`, `Set-ItemProperty`, and
424424
`Rename-ItemProperty` cmdlets.
425425
- `Set-Item` is designed to work with the data exposed by any provider.
426-
To list the providers available in your session, type `Get-PsProvider`.
426+
To list the providers available in your session, type `Get-PSProvider`.
427427
For more information, see [about_Providers](../Microsoft.PowerShell.Core/About/about_Providers.md).
428428

429429
## RELATED LINKS

reference/5.1/Microsoft.PowerShell.Management/Split-Path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ Accept wildcard characters: True
299299
### -Qualifier
300300

301301
Indicates that this cmdlet returns only the qualifier of the specified path. For the FileSystem or
302-
registry providers, the qualifier is the drive of the provider path, such as `C:` or `HKCU:`.
302+
Registry providers, the qualifier is the drive of the provider path, such as `C:` or `HKCU:`.
303303

304304
```yaml
305305
Type: System.Management.Automation.SwitchParameter

0 commit comments

Comments
 (0)