Skip to content

Commit 8928c0f

Browse files
Fix incorrect case/capitalization in ref docs (#11928)
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 1e3bbd0 commit 8928c0f

40 files changed

+205
-201
lines changed

reference/5.1/Microsoft.PowerShell.Utility/ConvertTo-Xml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Accept wildcard characters: False
107107
### -InputObject
108108
109109
Specifies the object to be converted. Enter a variable that contains the objects, or type a command
110-
or expression that gets the objects. You can also pipe objects to `ConvertTo-XML`.
110+
or expression that gets the objects. You can also pipe objects to `ConvertTo-Xml`.
111111

112112
```yaml
113113
Type: System.Management.Automation.PSObject

reference/5.1/Microsoft.PowerShell.Utility/Export-Alias.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ The acceptable values for this parameter are:
128128
129129
- CSV. Comma-separated value (CSV) format.
130130
- Script. Creates a `Set-Alias` command for each exported alias. If you name the output file with a
131-
.ps1 file name extension, you can run it as a script to add the aliases to any session.
131+
`.ps1` file name extension, you can run it as a script to add the aliases to any session.
132132

133133
```yaml
134134
Type: Microsoft.PowerShell.Commands.ExportAliasFormat

reference/5.1/Microsoft.PowerShell.Utility/Export-Clixml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ recreate the saved object based on the contents of that file. For more informati
3737
[Language independence](/dotnet/standard/language-independence).
3838

3939
This cmdlet is similar to `ConvertTo-Xml`, except that `Export-Clixml` stores the resulting XML in a
40-
file. `ConvertTo-XML` returns the XML, so you can continue to process it in PowerShell.
40+
file. `ConvertTo-Xml` returns the XML, so you can continue to process it in PowerShell.
4141

4242
A valuable use of `Export-Clixml` on Windows computers is to export credentials and secure strings
4343
securely as XML. For an example, see Example 3.

reference/5.1/Microsoft.PowerShell.Utility/Export-Csv.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ Export-Csv [[-Path] <string>] -InputObject <psobject> [-LiteralPath <string>] [-
3434

3535
## DESCRIPTION
3636

37-
The `Export-CSV` cmdlet creates a CSV file of the objects that you submit. Each object is a row that
38-
includes a character-separated list of the object's property values. You can use the `Export-CSV`
37+
The `Export-Csv` cmdlet creates a CSV file of the objects that you submit. Each object is a row that
38+
includes a character-separated list of the object's property values. You can use the `Export-Csv`
3939
cmdlet to create spreadsheets and share data with programs that accept CSV files as input.
4040

41-
Do not format objects before sending them to the `Export-CSV` cmdlet. If `Export-CSV` receives
41+
Do not format objects before sending them to the `Export-Csv` cmdlet. If `Export-Csv` receives
4242
formatted objects the CSV file contains the format properties rather than the object properties. To
4343
export only selected properties of an object, use the `Select-Object` cmdlet.
4444

@@ -301,9 +301,9 @@ This example shows how to use the **Force** and **Append** parameters. When thes
301301
combined, mismatched object properties can be written to a CSV file.
302302

303303
```powershell
304-
$Content = [PSCustomObject]@{Name = 'PowerShell'; Version = '7.0'}
304+
$Content = [pscustomobject]@{Name = 'PowerShell'; Version = '7.0'}
305305
$Content | Export-Csv -Path .\ParmFile.csv -NoTypeInformation
306-
$AdditionalContent = [PSCustomObject]@{Name = 'Windows PowerShell'; Edition = 'Desktop'}
306+
$AdditionalContent = [pscustomobject]@{Name = 'Windows PowerShell'; Edition = 'Desktop'}
307307
$AdditionalContent | Export-Csv -Path .\ParmFile.csv -NoTypeInformation -Append
308308
```
309309

@@ -351,8 +351,8 @@ the file located in the current directory.
351351

352352
### -Append
353353

354-
Use this parameter so that `Export-CSV` adds CSV output to the end of the specified file. Without
355-
this parameter, `Export-CSV` replaces the file contents without warning.
354+
Use this parameter so that `Export-Csv` adds CSV output to the end of the specified file. Without
355+
this parameter, `Export-Csv` replaces the file contents without warning.
356356

357357
This parameter was introduced in Windows PowerShell 3.0.
358358

@@ -436,7 +436,7 @@ Accept wildcard characters: False
436436
### -InputObject
437437

438438
Specifies the objects to export as CSV strings. Enter a variable that contains the objects or type a
439-
command or expression that gets the objects. You can also pipe objects to `Export-CSV`.
439+
command or expression that gets the objects. You can also pipe objects to `Export-Csv`.
440440

441441
```yaml
442442
Type: System.Management.Automation.PSObject
@@ -471,8 +471,8 @@ Accept wildcard characters: False
471471

472472
### -NoClobber
473473

474-
Use this parameter so that `Export-CSV` does not overwrite an existing file. By default, if the file
475-
exists in the specified path, `Export-CSV` overwrites the file without warning.
474+
Use this parameter so that `Export-Csv` does not overwrite an existing file. By default, if the file
475+
exists in the specified path, `Export-Csv` overwrites the file without warning.
476476

477477
```yaml
478478
Type: System.Management.Automation.SwitchParameter
@@ -594,13 +594,13 @@ Windows PowerShell includes the following aliases for `Export-Csv`:
594594

595595
- `epcsv`
596596

597-
The `Export-CSV` cmdlet converts the objects that you submit into a series of CSV strings and saves
598-
them in the specified text file. You can use `Export-CSV` to save objects in a CSV file and then use
597+
The `Export-Csv` cmdlet converts the objects that you submit into a series of CSV strings and saves
598+
them in the specified text file. You can use `Export-Csv` to save objects in a CSV file and then use
599599
the `Import-Csv` cmdlet to create objects from the CSV file.
600600

601601
In the CSV file, each object is represented by a character-separated list of the property values of
602602
the object. The property values are converted to strings using the **ToString()** method. The
603-
strings are represented by the property value name. `Export-CSV does not export the methods of the
603+
strings are represented by the property value name. `Export-Csv does not export the methods of the
604604
object.
605605

606606
The CSV strings are output as follows:
@@ -611,7 +611,7 @@ The CSV strings are output as follows:
611611
contain the first object's property names as a character-separated list.
612612
- The remaining strings contain character-separated lists of each object's property values.
613613

614-
When you submit multiple objects to `Export-CSV`, `Export-CSV` organizes the file based on the
614+
When you submit multiple objects to `Export-Csv`, `Export-Csv` organizes the file based on the
615615
properties of the first object that you submit. If the remaining objects do not have one of the
616616
specified properties, the property value of that object is null, as represented by two consecutive
617617
commas. If the remaining objects have additional properties, those property values are not included
@@ -622,7 +622,7 @@ resulting objects are CSV versions of the original objects that consist of strin
622622
the property values and no methods.
623623

624624
The `ConvertTo-Csv` and `ConvertFrom-Csv` cmdlets convert objects to CSV strings and from CSV
625-
strings. `Export-CSV` is the same as `ConvertTo-CSV`, except that it saves the CSV strings in a
625+
strings. `Export-Csv` is the same as `ConvertTo-Csv`, except that it saves the CSV strings in a
626626
file.
627627

628628
## RELATED LINKS

reference/5.1/Microsoft.PowerShell.Utility/Export-FormatData.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ Export-FormatData -InputObject <ExtendedTypeDefinition[]> -LiteralPath <String>
3131

3232
## DESCRIPTION
3333

34-
The `Export-FormatData` cmdlet creates Windows PowerShell formatting files (format.ps1xml) from
34+
The `Export-FormatData` cmdlet creates Windows PowerShell formatting files (`format.ps1xml`) from
3535
the formatting objects in the current session. It takes the **ExtendedTypeDefinition** objects that
3636
`Get-FormatData` returns and saves them in a file in XML format.
3737

38-
Windows PowerShell uses the data in formatting files (format.ps1xml) to generate the default display
39-
of Microsoft .NET Framework objects in the session. You can view and edit the formatting files and
40-
use the Update-FormatData cmdlet to add the formatting data to a session.
38+
Windows PowerShell uses the data in formatting files (`format.ps1xml`) to generate the default
39+
display of Microsoft .NET Framework objects in the session. You can view and edit the formatting
40+
files and use the Update-FormatData cmdlet to add the formatting data to a session.
4141

4242
For more information about formatting files in Windows PowerShell, see [about_Format.ps1xml](../Microsoft.PowerShell.Core/About/about_Format.ps1xml.md).
4343

@@ -46,16 +46,16 @@ For more information about formatting files in Windows PowerShell, see [about_Fo
4646
### Example 1: Export session format data
4747

4848
```powershell
49-
Get-FormatData -TypeName "*" | Export-FormatData -Path "allformat.ps1xml" -IncludeScriptBlock
49+
Get-FormatData -TypeName "*" | Export-FormatData -Path "AllFormat.ps1xml" -IncludeScriptBlock
5050
```
5151

52-
This command exports all of the format data in the session to the AllFormat.ps1xml file.
52+
This command exports all of the format data in the session to the `AllFormat.ps1xml` file.
5353

5454
The command uses the `Get-FormatData` cmdlet to get the format data in the session. A value of `*`
5555
(all) for the **TypeName** parameter directs the cmdlet to get all of the data in the session.
5656

5757
The command uses a pipeline operator (`|`) to send the format data from the `Get-FormatData` command
58-
to the `Export-FormatData` cmdlet, which exports the format data to the AllFormat.ps1 file.
58+
to the `Export-FormatData` cmdlet, which exports the format data to the `AllFormat.ps1xml` file.
5959

6060
The `Export-FormatData` command uses the **IncludeScriptBlock** parameter to include script blocks
6161
in the format data in the file.
@@ -64,10 +64,11 @@ in the format data in the file.
6464

6565
```powershell
6666
$F = Get-FormatData -TypeName "helpinfoshort"
67-
Export-FormatData -InputObject $F -Path "c:\test\help.format.ps1xml" -IncludeScriptBlock
67+
Export-FormatData -InputObject $F -Path "C:\test\Help.format.ps1xml" -IncludeScriptBlock
6868
```
6969

70-
These commands export the format data for the **HelpInfoShort** type to the Help.format.ps1xml file.
70+
These commands export the format data for the **HelpInfoShort** type to the `Help.format.ps1xml`
71+
file.
7172

7273
The first command uses the `Get-FormatData` cmdlet to get the format data for the **HelpInfoShort**
7374
type, and it saves it in the `$F` variable.
@@ -79,8 +80,8 @@ script blocks in the output.
7980
### Example 3: Export format data without a script block
8081

8182
```powershell
82-
Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path process.format.ps1xml
83-
Update-FormatData -PrependPath ".\process.format.ps1xml"
83+
Get-FormatData -TypeName "System.Diagnostics.Process" | Export-FormatData -Path Process.format.ps1xml
84+
Update-FormatData -PrependPath ".\Process.format.ps1xml"
8485
Get-Process p*
8586
```
8687

@@ -98,14 +99,14 @@ This example shows the effect of omitting the **IncludeScriptBlock** parameter f
9899
The first command uses the `Get-FormatData` cmdlet to get the format data for the
99100
**System.Diagnostics.Process** object that the Get-Process cmdlet returns. The command uses a
100101
pipeline operator (`|`) to send the formatting data to the `Export-FormatData` cmdlet, which exports
101-
it to the Process.format.ps1xml file in the current directory.
102+
it to the `Process.format.ps1xml` file in the current directory.
102103

103104
In this case, the `Export-FormatData` command does not use the **IncludeScriptBlock** parameter.
104105

105-
The second command uses the `Update-FormatData` cmdlet to add the Process.format.ps1xml file to the
106-
current session. The command uses the **PrependPath** parameter to ensure that the formatting data for
107-
process objects in the Process.format.ps1xml file is found before the standard formatting data for
108-
process objects.
106+
The second command uses the `Update-FormatData` cmdlet to add the `Process.format.ps1xml` file to
107+
the current session. The command uses the **PrependPath** parameter to ensure that the formatting
108+
data for process objects in the Process.format.ps1xml file is found before the standard formatting
109+
data for process objects.
109110

110111
The third command shows the effects of this change. The command uses the `Get-Process` cmdlet to
111112
get processes that have names that begin with P. The output shows that property values that are
@@ -206,10 +207,10 @@ Accept wildcard characters: False
206207
### -Path
207208

208209
Specifies a location for the output file.
209-
Enter a path (optional) and file name with a format.ps1xml file name extension.
210+
Enter a path (optional) and file name with a `format.ps1xml` file name extension.
210211
If you omit the path, `Export-FormatData` creates the file in the current directory.
211212

212-
If you use a file name extension other than .ps1xml, the `Update-FormatData` cmdlet will not
213+
If you use a file name extension other than `.ps1xml`, the `Update-FormatData` cmdlet will not
213214
recognize the file.
214215

215216
If you specify an existing file, `Export-FormatData` overwrites the file without warning, unless

reference/5.1/Microsoft.PowerShell.Utility/Export-PSSession.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ Exports the variant of the command that results from using the specified argumen
183183
values).
184184
185185
For example, to export the variant of the `Get-Item` command in the certificate (Cert:) drive in
186-
the PSSession in `$S`, type `Export-PSSession -Session $S -Command Get-Item -ArgumentList cert:`.
186+
the PSSession in `$S`, type `Export-PSSession -Session $S -Command Get-Item -ArgumentList Cert:`.
187187

188188
```yaml
189189
Type: System.Object[]
@@ -200,7 +200,7 @@ Accept wildcard characters: False
200200
### -Certificate
201201

202202
Specifies the client certificate that is used to sign the format files (*.Format.ps1xml) or script
203-
module files (.psm1) in the module that `Export-PSSession` creates. Enter a variable that contains
203+
module files (`.psm1`) in the module that `Export-PSSession` creates. Enter a variable that contains
204204
a certificate or a command or expression that gets the certificate.
205205

206206
To find a certificate, use the `Get-PfxCertificate` cmdlet or use the `Get-ChildItem` cmdlet in the
@@ -253,13 +253,13 @@ The acceptable values for this parameter are as follows:
253253

254254
- `Alias`: All PowerShell aliases in the current session.
255255
- `All`: All command types. It is the equivalent of `Get-Command -Name *`.
256-
- `Application`: All files other than PowerShell files in paths listed in the Path environment
257-
variable (`$env:path`), including .txt, .exe, and .dll files.
256+
- `Application`: All files other than PowerShell files in paths listed in the PATH environment
257+
variable (`$Env:PATH`), including .txt, .exe, and .dll files.
258258
- `Cmdlet`: The cmdlets in the current session. Cmdlet is the default.
259259
- `Configuration`: A PowerShell configuration. For more information, see
260260
[about_Session_Configurations](../Microsoft.PowerShell.Core/About/about_Session_Configurations.md).
261-
- `ExternalScript`: All .ps1 files in the paths listed in the Path environment variable
262-
(`$env:path`).
261+
- `ExternalScript`: All `.ps1` files in the paths listed in the PATH environment variable
262+
(`$Env:PATH`).
263263
- `Filter` and `Function`: All PowerShell functions.
264264
- `Script` Script blocks in the current session.
265265
- `Workflow` A PowerShell workflow. For more information, see [about_Workflows](../PSWorkflow/About/about_Workflows.md).

reference/5.1/Microsoft.PowerShell.Utility/Format-Hex.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Specifies the objects to be formatted. Enter a variable that contains the object
157157
or expression that gets the objects.
158158
159159
Only certain [scalar](/powershell/scripting/learn/glossary#scalar-value) types and
160-
`[system.io.fileinfo]` are supported.
160+
`[System.IO.FileInfo]` are supported.
161161

162162
The supported scalar types are:
163163

reference/5.1/Microsoft.PowerShell.Utility/Format-List.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ If you do not use a format cmdlet, PowerShell applies that default format for ea
316316
displays.
317317

318318
The **View** parameter lets you specify an alternate format for the table. You can use the views
319-
defined in the `*.format.PS1XML` files in the PowerShell directory, or you can create your own views
319+
defined in the `*.format.ps1xml` files in the PowerShell directory, or you can create your own views
320320
in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
321321

322322
The alternate view for the **View** parameter must use the list format, otherwise, the command

reference/5.1/Microsoft.PowerShell.Utility/Format-Table.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ more information about views and the code used to create this example's view, se
103103
[about_Format.ps1xml](../Microsoft.PowerShell.Core/About/about_Format.ps1xml.md#sample-xml-for-a-format-table-custom-view).
104104

105105
```powershell
106-
Get-ChildItem -Path C:\Test | Format-Table -View mygciview
106+
Get-ChildItem -Path C:\Test | Format-Table -View MyGciView
107107
```
108108

109109
```Output
@@ -121,7 +121,7 @@ d----- 10/23/2019 09:38 2/25/2019 09:38 Files
121121

122122
`Get-ChildItem` gets the contents of the current directory, `C:\Test`. The
123123
**System.IO.DirectoryInfo** and **System.IO.FileInfo** objects are sent down the pipeline.
124-
`Format-Table` uses the **View** parameter to specify the custom view **mygciview** that includes
124+
`Format-Table` uses the **View** parameter to specify the custom view **MyGciView** that includes
125125
the **CreationTime** column.
126126

127127
The default `Format-Table` output for `Get-ChildItem` doesn't include the **CreationTime** column.
@@ -177,7 +177,7 @@ local computer. You can use `Get-CimInstance` with the **ComputerName** paramete
177177
from remote computers.
178178

179179
```powershell
180-
$Processes = Get-CimInstance -Class win32_process -Filter "name='notepad.exe'"
180+
$Processes = Get-CimInstance -Class Win32_Process -Filter "name='notepad.exe'"
181181
$Processes | Format-Table ProcessName, @{
182182
Label = "Total Running Time"
183183
Expression={(Get-Date) - $_.CreationDate}

reference/5.1/Microsoft.PowerShell.Utility/Format-Wide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ output. The **Column** parameter specifies the number of columns.
4646
This command displays the names of registry keys in the `HKEY_CURRENT_USER\Software\Microsoft` key.
4747

4848
```powershell
49-
Get-ChildItem HKCU:\software\microsoft | Format-Wide -Property pschildname -AutoSize
49+
Get-ChildItem HKCU:\software\Microsoft | Format-Wide -Property PSChildName -AutoSize
5050
```
5151

5252
The `Get-ChildItem` cmdlet gets objects representing the keys. The path is specified as `HKCU:`, one
@@ -309,7 +309,7 @@ Windows PowerShell includes the following aliases for `Format-Wide`:
309309
- `fw`
310310

311311
The **View** parameter lets you specify an alternate format for the table. You can use the views
312-
defined in the `*.format.PS1XML` files in the PowerShell directory or you can create your own views
312+
defined in the `*.format.ps1xml` files in the PowerShell directory or you can create your own views
313313
in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
314314

315315
The alternate view for the **View** parameter must use table format; if it does not, the command

0 commit comments

Comments
 (0)