Skip to content

Commit 84c9e05

Browse files
Fix incorrect case/capitalization in ref docs (#11942)
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 616646a commit 84c9e05

40 files changed

+225
-225
lines changed

reference/docs-conceptual/developer/format/list-view-groupby.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: List View (GroupBy)
77
# List View (GroupBy)
88

99
This example shows how to implement a list view that separates the rows of the list into groups.
10-
This list view displays the properties of the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
10+
This list view displays the properties of the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
1111
objects returned by the [Get-Service](/powershell/module/Microsoft.PowerShell.Management/Get-Service)
1212
cmdlet. For more information about the components of a list view, see [Creating a List View](./creating-a-list-view.md).
1313

@@ -19,11 +19,11 @@ cmdlet. For more information about the components of a list view, see [Creating
1919
formatting file.
2020

2121
1. Open Windows PowerShell, and run the following command to load the formatting file into the
22-
current session: `Update-formatdata -prependpath PathToFormattingFile`.
22+
current session: `Update-FormatData -PrependPath PathToFormattingFile`.
2323

2424
> [!WARNING]
2525
> This formatting file defines the display of an object that is already defined by a Windows
26-
> PowerShell formatting file. You must use the `prependPath` parameter when you run the cmdlet, and
26+
> PowerShell formatting file. You must use the `PrependPath` parameter when you run the cmdlet, and
2727
> you cannot load this formatting file as a module.
2828
2929
## Demonstrates
@@ -49,7 +49,7 @@ This formatting file demonstrates the following XML elements:
4949

5050
## Example
5151

52-
The following XML defines a list view that starts a new group whenever the value of the [System.Serviceprocess.Servicecontroller.Status](/dotnet/api/System.ServiceProcess.ServiceController.Status)
52+
The following XML defines a list view that starts a new group whenever the value of the [System.ServiceProcess.ServiceController.Status](/dotnet/api/System.ServiceProcess.ServiceController.Status)
5353
property changes. When each group is started, a custom label is displayed that includes the new
5454
value of the property.
5555

@@ -87,7 +87,7 @@ value of the property.
8787
</Configuration>
8888
```
8989

90-
The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
90+
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
9191
objects after this format file is loaded. The blank lines added before and after the group label are
9292
automatically added by Windows PowerShell.
9393

reference/docs-conceptual/developer/format/list-view-labels.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: List View (Labels)
77
# List View (Labels)
88

99
This example shows how to implement a list view that displays a custom label for each row of the
10-
list. This list view displays the properties of the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
10+
list. This list view displays the properties of the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
1111
object that is returned by the [Get-Service](/powershell/module/Microsoft.PowerShell.Management/Get-Service)
1212
cmdlet. For more information about the components of a list view, see [Creating a List View](./creating-a-list-view.md).
1313

@@ -19,12 +19,12 @@ cmdlet. For more information about the components of a list view, see [Creating
1919
formatting file.
2020

2121
1. Open Windows PowerShell, and run the following command to load the formatting file into the
22-
current session: `Update-formatdata -prependpath PathToFormattingFile`.
22+
current session: `Update-FormatData -PrependPath PathToFormattingFile`.
2323

2424
> [!WARNING]
2525
2626
> This formatting file defines the display of an object that is already defined by a Windows
27-
> PowerShell formatting file. You must use the `prependPath` parameter when you run the cmdlet, and
27+
> PowerShell formatting file. You must use the `PrependPath` parameter when you run the cmdlet, and
2828
> you cannot load this formatting file as a module.
2929
3030
## Demonstrates
@@ -92,7 +92,7 @@ the name of the property is displayed followed by the value of the property.
9292
</Configuration>
9393
```
9494

95-
The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
95+
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
9696
objects after this format file is loaded.
9797

9898
```powershell

reference/docs-conceptual/developer/format/name-element-for-view-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ For more information about the different types of views, see the following topic
5353

5454
## Example
5555

56-
The following example shows a `View` element that defines a table view for the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
56+
The following example shows a `View` element that defines a table view for the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
5757
object. The name of the view is "service".
5858

5959
```xml

reference/docs-conceptual/developer/format/tablecontrol-element-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ For more information about the components of a table view, see [Creating a Table
5656

5757
## Example
5858

59-
This example shows a `TableControl` element that is used to display the properties of the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
59+
This example shows a `TableControl` element that is used to display the properties of the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
6060
object.
6161

6262
```xml

reference/docs-conceptual/developer/format/typename-element-for-viewselectedby-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ and [Custom View Components](./creating-custom-controls.md).
5353

5454
## Example
5555

56-
The following example shows how to specify the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
56+
The following example shows how to specify the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
5757
object for a list view. The same schema is used for table, wide, and custom views.
5858

5959
```xml

reference/docs-conceptual/developer/format/view-element-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ topics:
7777

7878
## Example
7979

80-
This example shows a `View` element that defines a table view for the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
80+
This example shows a `View` element that defines a table view for the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
8181
object.
8282

8383
```xml

reference/docs-conceptual/developer/format/viewselectedby-element-format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ referenced, see [Defining Sets of Objects](./defining-selection-sets.md).
5858

5959
## Example
6060

61-
The following example shows how to specify the [System.Serviceprocess.Servicecontroller](/dotnet/api/System.ServiceProcess.ServiceController)
61+
The following example shows how to specify the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
6262
object for a list view. The same schema is used for table, wide, and custom views.
6363

6464
```xml

reference/docs-conceptual/developer/format/wide-view-basic.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Wide View (Basic)
66
---
77
# Wide View (Basic)
88

9-
This example shows how to implement a basic wide view that displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
9+
This example shows how to implement a basic wide view that displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
1010
objects returned by the `Get-Service` cmdlet. For more information about the components of a wide
1111
view, see [Creating a Wide View](./creating-a-wide-view.md).
1212

@@ -37,7 +37,7 @@ This formatting file demonstrates the following XML elements:
3737

3838
## Example
3939

40-
The following XML defines a wide view that displays the value of the [System.Serviceprocess.Servicecontroller.Servicename](/dotnet/api/System.ServiceProcess.ServiceController.ServiceName) property.
40+
The following XML defines a wide view that displays the value of the [System.ServiceProcess.ServiceController.ServiceName](/dotnet/api/System.ServiceProcess.ServiceController.ServiceName) property.
4141

4242
```xml
4343
<?xml version="1.0" encoding="utf-8" ?>
@@ -63,7 +63,7 @@ The following XML defines a wide view that displays the value of the [System.Ser
6363
</Configuration>
6464
```
6565

66-
The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
66+
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
6767
objects after this format file is loaded.
6868

6969
```powershell

reference/docs-conceptual/developer/format/wide-view-groupby.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: Wide View (GroupBy)
66
---
77
# Wide View (GroupBy)
88

9-
This example shows how to implement a wide view that displays groups of [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
9+
This example shows how to implement a wide view that displays groups of [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
1010
objects returned by the `Get-Service` cmdlet. For more information about the components of a wide
1111
view, see [Creating a Wide View](./creating-a-wide-view.md).
1212

@@ -40,7 +40,7 @@ This formatting file demonstrates the following XML elements:
4040
## Example
4141

4242
The following XML defines a wide view that displays groups of objects. Each new group is started
43-
when the value of the [System.Serviceprocess.Servicecontroller.Servicetype](/dotnet/api/System.ServiceProcess.ServiceController.ServiceType)
43+
when the value of the [System.ServiceProcess.ServiceController.ServiceType](/dotnet/api/System.ServiceProcess.ServiceController.ServiceType)
4444
property changes.
4545

4646
```xml
@@ -71,7 +71,7 @@ property changes.
7171
</Configuration>
7272
```
7373

74-
The following example shows how Windows PowerShell displays the [System.Serviceprocess.Servicecontroller?Displayproperty=Fullname](/dotnet/api/System.ServiceProcess.ServiceController)
74+
The following example shows how Windows PowerShell displays the [System.ServiceProcess.ServiceController](/dotnet/api/System.ServiceProcess.ServiceController)
7575
objects after this format file is loaded.
7676

7777
```powershell

reference/docs-conceptual/developer/help/autogenerated-elements-of-comment-based-help.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ its capitalization, change the function definition or the script filename.
2323

2424
### Syntax
2525

26-
The Syntax section of the Help topic is generated from the parameter list in the Param statement of
27-
the function or script. To add detail to the Help topic syntax, such as the .NET type of a
26+
The Syntax section of the Help topic is generated from the parameter list in the `param` statement
27+
of the function or script. To add detail to the Help topic syntax, such as the .NET type of a
2828
parameter, add the detail to the parameter list. If you don't specify a parameter type, the
2929
**Object** type is inserted as the default value.
3030

3131
### Parameter List
3232

3333
The Parameters section of the Help topic is generated from the parameter list in the function or
34-
script and from the descriptions that you add using the `.Parameters` keyword or comments in the
34+
script and from the descriptions that you add using the `.PARAMETER` keyword or comments in the
3535
parameter list.
3636

3737
Parameters appear in the Parameters section in the same order that they appear in the parameter
3838
list. The spelling and capitalization of parameter names is also taken from the parameter list; it
39-
isn't affected by the parameter name specified by the `.Parameter` keyword.
39+
isn't affected by the parameter name specified by the `.PARAMETER` keyword.
4040

4141
### Common Parameters
4242

0 commit comments

Comments
 (0)