Skip to content

Commit f739062

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 f739062

40 files changed

+174
-174
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,15 +90,15 @@ parameter gets the alias when you know the item name.
9090
### Example 4: Get aliases by property
9191

9292
```powershell
93-
Get-Alias | Where-Object {$_.Options -Match "ReadOnly"}
93+
Get-Alias | Where-Object {$_.Options -match "ReadOnly"}
9494
```
9595

9696
This command gets all aliases in which the value of the **Options** property is **ReadOnly**. This
9797
command provides a quick way to find the aliases that are built into PowerShell, because they have
9898
the **ReadOnly** option.
9999

100100
**Options** is just one property of the **AliasInfo** objects that `Get-Alias` gets. To find all
101-
properties and methods of **AliasInfo** objects, type `Get-Alias | get-member`.
101+
properties and methods of **AliasInfo** objects, type `Get-Alias | Get-Member`.
102102

103103
### Example 5: Get aliases by name and filter by beginning letter
104104

reference/5.1/Microsoft.PowerShell.Utility/Get-Date.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Get-Date [[-Date] <DateTime>] [-Year <Int32>] [-Month <Int32>] [-Day <Int32>] [-
3434
## DESCRIPTION
3535

3636
The `Get-Date` cmdlet gets a **DateTime** object that represents the current date or a date that you
37-
specify. `Get-Date` can format the date and time in several .NET and UNIX formats. You can use
37+
specify. `Get-Date` can format the date and time in several .NET and Unix formats. You can use
3838
`Get-Date` to generate a date or time character string, and then send the string to other cmdlets or
3939
programs.
4040

@@ -144,7 +144,7 @@ The Gregorian calendar has 365 days, except for leap years that have 366 days. F
144144
```
145145

146146
`Get-Date` uses three parameters to specify the date: **Year**, **Month**, and **Day**. The command
147-
is wrapped with parentheses so that the result is evaluated by the **DayofYear** property.
147+
is wrapped with parentheses so that the result is evaluated by the **DayOfYear** property.
148148

149149
### Example 6: Check if a date is adjusted for daylight saving time
150150

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

437437
### -UFormat
438438

439-
Displays the date and time in UNIX format. The **UFormat** parameter outputs a string object.
439+
Displays the date and time in Unix format. The **UFormat** parameter outputs a string object.
440440

441441
**UFormat** specifiers are preceded by a percent sign (`%`), for example, `%m`, `%d`, and `%Y`. The
442442
[Notes](#notes) section contains a table of valid **UFormat specifiers**.

reference/5.1/Microsoft.PowerShell.Utility/Get-Event.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ SourceEventArgs : System.Management.EventArrivedEventArgs
7272
SourceArgs : {System.Management.ManagementEventWatcher, System.Management.EventArrivedEventArgs}
7373
SourceIdentifier : ProcessStarted
7474
TimeGenerated : 11/13/2008 12:09:32 PM
75-
MessageData : PS C:\> Get-Event | Where {$_.TimeGenerated -ge "11/13/2008 12:15:00 PM"}
75+
MessageData : PS C:\> Get-Event | where {$_.TimeGenerated -ge "11/13/2008 12:15:00 PM"}
7676
ComputerName :
7777
RunspaceId : c2153740-256d-46c0-a57c-b8059325d1a0
7878
EventIdentifier : 1

reference/5.1/Microsoft.PowerShell.Utility/Get-EventSubscriber.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,15 +113,15 @@ Id Name State HasMoreData Location Command
113113
```powershell
114114
$Timer.Enabled = $true
115115
$Subscriber = Get-EventSubscriber -SourceIdentifier Timer.Random
116-
($Subscriber.action).gettype().fullname
116+
($Subscriber.Action).GetType().FullName
117117
```
118118

119119
```Output
120120
System.Management.Automation.PSEventJob
121121
```
122122

123123
```powershell
124-
$Subscriber.action | Format-List -Property *
124+
$Subscriber.Action | Format-List -Property *
125125
```
126126

127127
```Output
@@ -141,7 +141,7 @@ ChildJobs : {}
141141
```
142142

143143
```powershell
144-
& $Subscriber.action.module {$Random}
144+
& $Subscriber.Action.Module {$Random}
145145
```
146146

147147
The third command uses the `Register-ObjectEvent` cmdlet to register the Elapsed event of the timer
@@ -183,7 +183,7 @@ subscribers, including hidden subscribers.
183183

184184
```powershell
185185
Register-EngineEvent -SourceIdentifier PowerShell.Exiting -SupportEvent -Action {
186-
Get-History | Export-Clixml d:\temp\history.clixml
186+
Get-History | Export-Clixml D:\temp\history.clixml
187187
}
188188
Get-EventSubscriber # No output - must use -Force
189189
Get-EventSubscriber -Force

reference/5.1/Microsoft.PowerShell.Utility/Get-FileHash.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ is supported by the target operating system can be used.
5858

5959
### Example 1: Compute the hash value for a file
6060

61-
This example uses the `Get-FileHash` cmdlet to compute the hash value for the `Powershell.exe` file.
61+
This example uses the `Get-FileHash` cmdlet to compute the hash value for the `powershell.exe` file.
6262
The hash algorithm used is the default, SHA256. The output is piped to the `Format-List` cmdlet to
6363
format the output as a list.
6464

@@ -115,7 +115,7 @@ string to a stream and use the **InputStream** parameter of `Get-FileHash` to ge
115115
```powershell
116116
$stringAsStream = [System.IO.MemoryStream]::new()
117117
$writer = [System.IO.StreamWriter]::new($stringAsStream)
118-
$writer.write("Hello world")
118+
$writer.Write("Hello world")
119119
$writer.Flush()
120120
$stringAsStream.Position = 0
121121
Get-FileHash -InputStream $stringAsStream | Select-Object Hash

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ HelpInfoShort {help , TableControl}
6969
```
7070

7171
```powershell
72-
$F.FormatViewDefinition[0].control
72+
$F.FormatViewDefinition[0].Control
7373
```
7474

7575
```Output
@@ -85,7 +85,7 @@ OutOfBand : False
8585
```
8686

8787
```powershell
88-
$F.FormatViewDefinition[0].control.Headers
88+
$F.FormatViewDefinition[0].Control.Headers
8989
```
9090

9191
```Output
@@ -104,7 +104,7 @@ data that is added by a module.
104104

105105
```powershell
106106
$A = Get-FormatData
107-
Import-Module bitstransfer
107+
Import-Module BitsTransfer
108108
$B = Get-FormatData
109109
Compare-Object $A $B
110110
```
@@ -116,8 +116,8 @@ Microsoft.BackgroundIntelligentTransfer.Management.BitsJob =>
116116
```
117117

118118
```powershell
119-
Get-FormatData *bits* | Export-FormatData -FilePath c:\test\bits.format.ps1xml
120-
Get-Content c:\test\bits.format.ps1xml
119+
Get-FormatData *bits* | Export-FormatData -FilePath C:\test\Bits.format.ps1xml
120+
Get-Content C:\test\Bits.format.ps1xml
121121
```
122122

123123
```Output
@@ -132,7 +132,7 @@ identify the format type that the **BitsTransfer** module adds to the session.
132132
The fifth command uses the `Get-FormatData` cmdlet to get the format type that the **BitsTransfer**
133133
module adds. It uses a pipeline operator (`|`) to send the format type object to the
134134
`Export-FormatData` cmdlet, which converts it back to XML and saves it in the specified
135-
`format.ps1xml` file.
135+
`Bits.format.ps1xml` file.
136136

137137
The final command shows an excerpt of the `format.ps1xml` file content.
138138

reference/5.1/Microsoft.PowerShell.Utility/Get-Host.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Major Minor Build Revision
8484
This command gets detailed information about the version of Windows PowerShell running in the host.
8585
You can view, but not change, these values.
8686

87-
The Version property of `Get-Host` contains a **System.Version** object. This command uses a
87+
The **Version** property of `Get-Host` contains a **System.Version** object. This command uses a
8888
pipeline operator (`|`) to send the version object to the `Format-List` cmdlet. The `Format-List`
8989
command uses the **Property** parameter with a value of all (`*`) to display all of the properties
9090
and property values of the version object.
@@ -225,7 +225,7 @@ interchangeably.
225225

226226
This command uses the **PrivateData** property of `$Host` as its ErrorBackgroundColor property. To
227227
see all of the properties of the object in the `$Host`.PrivateData property, type
228-
`$Host.PrivateData | format-list *`.
228+
`$Host.PrivateData | Format-List *`.
229229

230230
## PARAMETERS
231231

reference/5.1/Microsoft.PowerShell.Utility/Get-Member.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -89,18 +89,18 @@ ToString ScriptMethod System.Object ToString();
8989
### Example 2: Get members of service objects
9090

9191
This example gets all the members (properties and methods) of service objects retrieved by the
92-
`Get-Service` cmdlet, including the intrinsic members, such as **PSBase**, **PSObject**, and the
92+
`Get-Service` cmdlet, including the intrinsic members, such as **psbase**, **psobject**, and the
9393
**get_** and **set_** methods.
9494

9595
```powershell
9696
Get-Service | Get-Member -Force
97-
(Get-Service Schedule).PSBase
97+
(Get-Service Schedule).psbase
9898
```
9999

100100
The `Get-Member` command uses the **Force** parameter to add the intrinsic members and
101101
compiler-generated members of the objects to the display. You can use these properties and methods
102102
in the same way that you would use an adapted method of the object. The second command shows how to
103-
display the value of the **PSBase** property of the Schedule service. For more information on
103+
display the value of the **psbase** property of the Schedule service. For more information on
104104
intrinsic members, see
105105
[about_Intrinsic_Members](../Microsoft.PowerShell.Core/About/about_Intrinsic_Members.md)
106106

@@ -244,8 +244,8 @@ returns the members of the **Object[]** type.
244244
This example shows how to determine which properties of an object can be changed.
245245

246246
```powershell
247-
$File = Get-Item c:\test\textFile.txt
248-
$File.PSObject.Properties | Where-Object isSettable | Select-Object -Property Name
247+
$File = Get-Item C:\test\textFile.txt
248+
$File.psobject.Properties | Where-Object IsSettable | Select-Object -Property Name
249249
```
250250

251251
```Output
@@ -271,13 +271,13 @@ Attributes
271271

272272
This example creates a new **PSObject** and adds properties to it. `Get-Member` lists the properties
273273
in alphabetic order. To see the properties in the order they were added to the object you must use
274-
the **PSObject** intrinsic member.
274+
the **psobject** intrinsic member.
275275

276276
```powershell
277-
$Asset = New-Object -TypeName PSObject
277+
$Asset = New-Object -TypeName psobject
278278
$d = [ordered]@{Name="Server30";System="Server Core";PSVersion="4.0"}
279279
$Asset | Add-Member -NotePropertyMembers $d -TypeName Asset
280-
$Asset.PSObject.Properties | Select-Object Name, Value
280+
$Asset.psobject.Properties | Select-Object Name, Value
281281
```
282282

283283
```Output
@@ -295,13 +295,13 @@ PSVersion 4.0
295295
Adds the intrinsic members and the compiler-generated **get_** and **set_** methods to the display.
296296
The following list describes the properties that are added when you use the **Force** parameter:
297297

298-
- `PSBase`: The original properties of the .NET object without extension or adaptation. These are
298+
- `psbase`: The original properties of the .NET object without extension or adaptation. These are
299299
the properties defined for the object class.
300-
- `PSAdapted`: The properties and methods defined in the PowerShell extended type system.
301-
- `PSExtended`: The properties and methods that were added in the `Types.ps1xml` files or using the
300+
- `psadapted`: The properties and methods defined in the PowerShell extended type system.
301+
- `psextended`: The properties and methods that were added in the `Types.ps1xml` files or using the
302302
`Add-Member` cmdlet.
303-
- `PSObject`: The adapter that converts the base object to a PowerShell **PSObject** object.
304-
- `PSTypeNames`: A list of object types that describe the object, in order of specificity. When
303+
- `psobject`: The adapter that converts the base object to a PowerShell **PSObject** object.
304+
- `pstypenames`: A list of object types that describe the object, in order of specificity. When
305305
formatting the object, PowerShell searches for the types in the `Format.ps1xml` files in the
306306
PowerShell installation directory (`$PSHOME`). It uses the formatting definition for the first
307307
type that it finds.

reference/5.1/Microsoft.PowerShell.Utility/Get-PSBreakpoint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Get-PSBreakpoint [-Id] <Int32[]> [<CommonParameters>]
4747

4848
## DESCRIPTION
4949

50-
The `Get-PSBreakPoint` cmdlet gets the breakpoints that are set in the current session. You can use
50+
The `Get-PSBreakpoint` cmdlet gets the breakpoints that are set in the current session. You can use
5151
the cmdlet parameters to get particular breakpoints.
5252

5353
A breakpoint is a point in a command or script where execution stops temporarily so that you can
@@ -204,7 +204,7 @@ acceptable values for this parameter are:
204204
- Command
205205
- Variable
206206

207-
You can also pipe breakpoint types to `Get-PSBreakPoint`.
207+
You can also pipe breakpoint types to `Get-PSBreakpoint`.
208208

209209
```yaml
210210
Type: Microsoft.PowerShell.Commands.BreakpointType[]

reference/5.1/Microsoft.PowerShell.Utility/Get-PSCallStack.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,32 +33,32 @@ To run a `Get-PSCallStack` command while in the debugger, type `k` or `Get-PSCal
3333
### Example 1: Get the call stack for a function
3434

3535
```powershell
36-
PS C:\> function my-alias {
36+
PS C:\> function My-Alias {
3737
$p = $args[0]
38-
Get-Alias | where {$_.definition -like "*$p"} | format-table definition, name -auto
38+
Get-Alias | where {$_.Definition -like "*$p"} | Format-Table Definition, Name -Auto
3939
}
40-
PS C:\ps-test> Set-PSBreakpoint -Command my-alias
41-
Command : my-alias
40+
PS C:\ps-test> Set-PSBreakpoint -Command My-Alias
41+
Command : My-Alias
4242
Action :
4343
Enabled : True
4444
HitCount : 0
4545
Id : 0
46-
Script : prompt PS C:\> my-alias Get-Content
46+
Script : prompt PS C:\> My-Alias Get-Content
4747
4848
Entering debug mode. Use h or ? for help.
49-
Hit Command breakpoint on 'prompt:my-alias'
50-
my-alias get-content
49+
Hit Command breakpoint on 'prompt:My-Alias'
50+
My-Alias Get-Content
5151
[DBG]: PS C:\ps-test> s
5252
$p = $args[0]
5353
DEBUG: Stepped to ': $p = $args[0] '
5454
[DBG]: PS C:\ps-test> s
55-
get-alias | Where {$_.Definition -like "*$p*"} | format-table Definition,
56-
[DBG]: PS C:\ps-test>get-pscallstack
55+
Get-Alias | where {$_.Definition -like "*$p*"} | Format-Table Definition,
56+
[DBG]: PS C:\ps-test>Get-PSCallStack
5757
5858
Name CommandLineParameters UnboundArguments Location
5959
---- --------------------- ---------------- --------
6060
prompt {} {} prompt
61-
my-alias {} {get-content} prompt
61+
My-Alias {} {Get-Content} prompt
6262
prompt {} {} prompt
6363
6464
PS C:\> [DBG]: PS C:\ps-test> o

0 commit comments

Comments
 (0)