Skip to content

Commit a44ebe6

Browse files
sdwheelersdwheeler
authored
Fix formatting and Example #3 description (#8820)
1 parent c3b0306 commit a44ebe6

File tree

5 files changed

+83
-91
lines changed

5 files changed

+83
-91
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Management
5-
ms.date: 03/12/2020
5+
ms.date: 05/16/2022
66
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.management/resolve-path?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Resolve-Path
@@ -31,13 +31,13 @@ Resolve-Path -LiteralPath <String[]> [-Relative] [-Credential <PSCredential>] [-
3131

3232
The `Resolve-Path` cmdlet displays the items and containers that match the wildcard pattern at the
3333
location specified. The match can include files, folders, registry keys, or any other object
34-
accessible from a PSDrive provider.
34+
accessible from a **PSDrive** provider.
3535

3636
## EXAMPLES
3737

3838
### Example 1: Resolve the home folder path
3939

40-
The tilde character (~) is shorthand notation for the current user's home folder. This example
40+
The tilde character (`~`) is shorthand notation for the current user's home folder. This example
4141
shows `Resolve-Path` returning the fully qualified path value.
4242

4343
```powershell
@@ -62,17 +62,17 @@ Path
6262
C:\Windows
6363
```
6464

65-
When run from the root of the C: drive, this command returns the path of the Windows folder in the
66-
C: drive.
65+
When run from the root of the `C:` drive, this command returns the path of the `Windows` folder in
66+
the `C:` drive.
6767

6868
### Example 3: Get all paths in the Windows folder
6969

7070
```powershell
7171
PS C:\> "C:\windows\*" | Resolve-Path
7272
```
7373

74-
This command returns all of the folders in the C:\Windows folder. The command uses a pipeline
75-
operator (|) to send a path string to `Resolve-Path`.
74+
This command returns all the files and folders in the `C:\Windows` folder. The command uses a
75+
pipeline operator (`|`) to send a path string to `Resolve-Path`.
7676

7777
### Example 4: Resolve a UNC path
7878

@@ -94,11 +94,11 @@ PS C:\> Resolve-Path -Path "c:\prog*" -Relative
9494
.\programs.txt
9595
```
9696

97-
This command returns relative paths for the directories at the root of the C: drive.
97+
This command returns relative paths for the directories at the root of the `C:` drive.
9898

9999
### Example 6: Resolve a path containing brackets
100100

101-
This example uses the **LiteralPath** parameter to resolve the path of the Test\[xml\] subfolder.
101+
This example uses the **LiteralPath** parameter to resolve the path of the `Test[xml]` subfolder.
102102
Using **LiteralPath** causes the brackets to be treated as normal characters rather than a regular
103103
expression.
104104

@@ -222,7 +222,7 @@ Returns a **PathInfo** object. Returns a string value for the resolved path if y
222222

223223
## NOTES
224224

225-
The `*-Path` cmdlets work with the FileSystem, Registry, and Certificate providers.
225+
The `*-Path` cmdlets work with the **FileSystem**, **Registry**, and **Certificate** providers.
226226

227227
`Resolve-Path` is designed to work with any provider. To list the providers available in your
228228
session, type `Get-PSProvider`. For more information, see

‎reference/7.0/Microsoft.PowerShell.Management/Resolve-Path.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Management
5-
ms.date: 03/12/2020
5+
ms.date: 05/16/2022
66
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.management/resolve-path?view=powershell-7&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Resolve-Path
@@ -30,13 +30,13 @@ Resolve-Path -LiteralPath <String[]> [-Relative] [-Credential <PSCredential>] [<
3030

3131
The `Resolve-Path` cmdlet displays the items and containers that match the wildcard pattern at the
3232
location specified. The match can include files, folders, registry keys, or any other object
33-
accessible from a PSDrive provider.
33+
accessible from a **PSDrive** provider.
3434

3535
## EXAMPLES
3636

3737
### Example 1: Resolve the home folder path
3838

39-
The tilde character (~) is shorthand notation for the current user's home folder. This example
39+
The tilde character (`~`) is shorthand notation for the current user's home folder. This example
4040
shows `Resolve-Path` returning the fully qualified path value.
4141

4242
```powershell
@@ -61,17 +61,17 @@ Path
6161
C:\Windows
6262
```
6363

64-
When run from the root of the C: drive, this command returns the path of the Windows folder in the
65-
C: drive.
64+
When run from the root of the `C:` drive, this command returns the path of the `Windows` folder in
65+
the `C:` drive.
6666

6767
### Example 3: Get all paths in the Windows folder
6868

6969
```powershell
7070
PS C:\> "C:\windows\*" | Resolve-Path
7171
```
7272

73-
This command returns all of the folders in the C:\Windows folder. The command uses a pipeline
74-
operator (|) to send a path string to `Resolve-Path`.
73+
This command returns all the files and folders in the `C:\Windows` folder. The command uses a
74+
pipeline operator (`|`) to send a path string to `Resolve-Path`.
7575

7676
### Example 4: Resolve a UNC path
7777

@@ -93,11 +93,11 @@ PS C:\> Resolve-Path -Path "c:\prog*" -Relative
9393
.\programs.txt
9494
```
9595

96-
This command returns relative paths for the directories at the root of the C: drive.
96+
This command returns relative paths for the directories at the root of the `C:` drive.
9797

9898
### Example 6: Resolve a path containing brackets
9999

100-
This example uses the **LiteralPath** parameter to resolve the path of the Test\[xml\] subfolder.
100+
This example uses the **LiteralPath** parameter to resolve the path of the `Test[xml]` subfolder.
101101
Using **LiteralPath** causes the brackets to be treated as normal characters rather than a regular
102102
expression.
103103

@@ -204,7 +204,7 @@ Returns a **PathInfo** object. Returns a string value for the resolved path if y
204204

205205
## NOTES
206206

207-
The `*-Path` cmdlets work with the FileSystem, Registry, and Certificate providers.
207+
The `*-Path` cmdlets work with the **FileSystem**, **Registry**, and **Certificate** providers.
208208

209209
`Resolve-Path` is designed to work with any provider. To list the providers available in your
210210
session, type `Get-PSProvider`. For more information, see

‎reference/7.1/Microsoft.PowerShell.Management/Resolve-Path.md‎

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Management
5-
ms.date: 03/12/2020
5+
ms.date: 05/16/2022
66
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.management/resolve-path?view=powershell-7.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Resolve-Path
@@ -30,13 +30,13 @@ Resolve-Path -LiteralPath <String[]> [-Relative] [-Credential <PSCredential>] [<
3030

3131
The `Resolve-Path` cmdlet displays the items and containers that match the wildcard pattern at the
3232
location specified. The match can include files, folders, registry keys, or any other object
33-
accessible from a PSDrive provider.
33+
accessible from a **PSDrive** provider.
3434

3535
## EXAMPLES
3636

3737
### Example 1: Resolve the home folder path
3838

39-
The tilde character (~) is shorthand notation for the current user's home folder. This example
39+
The tilde character (`~`) is shorthand notation for the current user's home folder. This example
4040
shows `Resolve-Path` returning the fully qualified path value.
4141

4242
```powershell
@@ -61,17 +61,17 @@ Path
6161
C:\Windows
6262
```
6363

64-
When run from the root of the C: drive, this command returns the path of the Windows folder in the
65-
C: drive.
64+
When run from the root of the `C:` drive, this command returns the path of the `Windows` folder in
65+
the `C:` drive.
6666

6767
### Example 3: Get all paths in the Windows folder
6868

6969
```powershell
7070
PS C:\> "C:\windows\*" | Resolve-Path
7171
```
7272

73-
This command returns all of the folders in the C:\Windows folder. The command uses a pipeline
74-
operator (|) to send a path string to `Resolve-Path`.
73+
This command returns all the files and folders in the `C:\Windows` folder. The command uses a
74+
pipeline operator (`|`) to send a path string to `Resolve-Path`.
7575

7676
### Example 4: Resolve a UNC path
7777

@@ -93,11 +93,11 @@ PS C:\> Resolve-Path -Path "c:\prog*" -Relative
9393
.\programs.txt
9494
```
9595

96-
This command returns relative paths for the directories at the root of the C: drive.
96+
This command returns relative paths for the directories at the root of the `C:` drive.
9797

9898
### Example 6: Resolve a path containing brackets
9999

100-
This example uses the **LiteralPath** parameter to resolve the path of the Test\[xml\] subfolder.
100+
This example uses the **LiteralPath** parameter to resolve the path of the `Test[xml]` subfolder.
101101
Using **LiteralPath** causes the brackets to be treated as normal characters rather than a regular
102102
expression.
103103

@@ -109,8 +109,8 @@ PS C:\> Resolve-Path -LiteralPath 'test[xml]'
109109

110110
### -Credential
111111

112-
Specifies a user account that has permission to perform this action.
113-
The default is the current user.
112+
Specifies a user account that has permission to perform this action. The default is the current
113+
user.
114114

115115
Type a user name, such as User01 or Domain01\User01, or pass a **PSCredential** object. You can
116116
create a **PSCredential** object using the `Get-Credential` cmdlet. If you type a user name, this
@@ -132,11 +132,10 @@ Accept wildcard characters: False
132132
133133
### -LiteralPath
134134
135-
Specifies the path to be resolved.
136-
The value of the **LiteralPath** parameter is used exactly as typed.
137-
No characters are interpreted as wildcard characters.
138-
If the path includes escape characters, enclose it in single quotation marks.
139-
Single quotation marks tell PowerShell not to interpret any characters as escape sequences.
135+
Specifies the path to be resolved. The value of the **LiteralPath** parameter is used exactly as
136+
typed. No characters are interpreted as wildcard characters. If the path includes escape characters,
137+
enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any
138+
characters as escape sequences.
140139
141140
```yaml
142141
Type: System.String[]
@@ -152,10 +151,8 @@ Accept wildcard characters: False
152151
153152
### -Path
154153
155-
Specifies the PowerShell path to resolve.
156-
This parameter is required.
157-
You can also pipe a path string to `Resolve-Path`.
158-
Wildcard characters are permitted.
154+
Specifies the PowerShell path to resolve. This parameter is required. You can also pipe a path
155+
string to `Resolve-Path`. Wildcard characters are permitted.
159156

160157
```yaml
161158
Type: System.String[]
@@ -189,13 +186,14 @@ Accept wildcard characters: False
189186

190187
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
191188
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
192-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
189+
-WarningAction, and -WarningVariable. For more information, see
190+
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
193191

194192
## INPUTS
195193

196194
### System.String
197195

198-
You can pipe a string that contains a path to this cmdlet
196+
You can pipe a string that contains a path to this cmdlet.
199197

200198
## OUTPUTS
201199

@@ -206,7 +204,7 @@ Returns a **PathInfo** object. Returns a string value for the resolved path if y
206204

207205
## NOTES
208206

209-
The `*-Path` cmdlets work with the FileSystem, Registry, and Certificate providers.
207+
The `*-Path` cmdlets work with the **FileSystem**, **Registry**, and **Certificate** providers.
210208

211209
`Resolve-Path` is designed to work with any provider. To list the providers available in your
212210
session, type `Get-PSProvider`. For more information, see

‎reference/7.2/Microsoft.PowerShell.Management/Resolve-Path.md‎

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: Microsoft.PowerShell.Commands.Management.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Management
5-
ms.date: 03/12/2020
5+
ms.date: 05/16/2022
66
online version: https://docs.microsoft.com/powershell/module/microsoft.powershell.management/resolve-path?view=powershell-7.2&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Resolve-Path
@@ -30,13 +30,13 @@ Resolve-Path -LiteralPath <String[]> [-Relative] [-Credential <PSCredential>] [<
3030

3131
The `Resolve-Path` cmdlet displays the items and containers that match the wildcard pattern at the
3232
location specified. The match can include files, folders, registry keys, or any other object
33-
accessible from a PSDrive provider.
33+
accessible from a **PSDrive** provider.
3434

3535
## EXAMPLES
3636

3737
### Example 1: Resolve the home folder path
3838

39-
The tilde character (~) is shorthand notation for the current user's home folder. This example
39+
The tilde character (`~`) is shorthand notation for the current user's home folder. This example
4040
shows `Resolve-Path` returning the fully qualified path value.
4141

4242
```powershell
@@ -61,17 +61,17 @@ Path
6161
C:\Windows
6262
```
6363

64-
When run from the root of the C: drive, this command returns the path of the Windows folder in the
65-
C: drive.
64+
When run from the root of the `C:` drive, this command returns the path of the `Windows` folder in
65+
the `C:` drive.
6666

6767
### Example 3: Get all paths in the Windows folder
6868

6969
```powershell
7070
PS C:\> "C:\windows\*" | Resolve-Path
7171
```
7272

73-
This command returns all of the folders in the C:\Windows folder. The command uses a pipeline
74-
operator (|) to send a path string to `Resolve-Path`.
73+
This command returns all the files and folders in the `C:\Windows` folder. The command uses a
74+
pipeline operator (`|`) to send a path string to `Resolve-Path`.
7575

7676
### Example 4: Resolve a UNC path
7777

@@ -93,11 +93,11 @@ PS C:\> Resolve-Path -Path "c:\prog*" -Relative
9393
.\programs.txt
9494
```
9595

96-
This command returns relative paths for the directories at the root of the C: drive.
96+
This command returns relative paths for the directories at the root of the `C:` drive.
9797

9898
### Example 6: Resolve a path containing brackets
9999

100-
This example uses the **LiteralPath** parameter to resolve the path of the Test\[xml\] subfolder.
100+
This example uses the **LiteralPath** parameter to resolve the path of the `Test[xml]` subfolder.
101101
Using **LiteralPath** causes the brackets to be treated as normal characters rather than a regular
102102
expression.
103103

@@ -109,8 +109,8 @@ PS C:\> Resolve-Path -LiteralPath 'test[xml]'
109109

110110
### -Credential
111111

112-
Specifies a user account that has permission to perform this action.
113-
The default is the current user.
112+
Specifies a user account that has permission to perform this action. The default is the current
113+
user.
114114

115115
Type a user name, such as User01 or Domain01\User01, or pass a **PSCredential** object. You can
116116
create a **PSCredential** object using the `Get-Credential` cmdlet. If you type a user name, this
@@ -132,11 +132,10 @@ Accept wildcard characters: False
132132
133133
### -LiteralPath
134134
135-
Specifies the path to be resolved.
136-
The value of the **LiteralPath** parameter is used exactly as typed.
137-
No characters are interpreted as wildcard characters.
138-
If the path includes escape characters, enclose it in single quotation marks.
139-
Single quotation marks tell PowerShell not to interpret any characters as escape sequences.
135+
Specifies the path to be resolved. The value of the **LiteralPath** parameter is used exactly as
136+
typed. No characters are interpreted as wildcard characters. If the path includes escape characters,
137+
enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any
138+
characters as escape sequences.
140139
141140
```yaml
142141
Type: System.String[]
@@ -152,10 +151,8 @@ Accept wildcard characters: False
152151
153152
### -Path
154153
155-
Specifies the PowerShell path to resolve.
156-
This parameter is required.
157-
You can also pipe a path string to `Resolve-Path`.
158-
Wildcard characters are permitted.
154+
Specifies the PowerShell path to resolve. This parameter is required. You can also pipe a path
155+
string to `Resolve-Path`. Wildcard characters are permitted.
159156

160157
```yaml
161158
Type: System.String[]
@@ -189,13 +186,14 @@ Accept wildcard characters: False
189186

190187
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
191188
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
192-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
189+
-WarningAction, and -WarningVariable. For more information, see
190+
[about_CommonParameters](../Microsoft.PowerShell.Core/About/about_CommonParameters.md).
193191

194192
## INPUTS
195193

196194
### System.String
197195

198-
You can pipe a string that contains a path to this cmdlet
196+
You can pipe a string that contains a path to this cmdlet.
199197

200198
## OUTPUTS
201199

@@ -206,7 +204,7 @@ Returns a **PathInfo** object. Returns a string value for the resolved path if y
206204

207205
## NOTES
208206

209-
The `*-Path` cmdlets work with the FileSystem, Registry, and Certificate providers.
207+
The `*-Path` cmdlets work with the **FileSystem**, **Registry**, and **Certificate** providers.
210208

211209
`Resolve-Path` is designed to work with any provider. To list the providers available in your
212210
session, type `Get-PSProvider`. For more information, see
@@ -224,4 +222,3 @@ exist yet.
224222
[Split-Path](Split-Path.md)
225223

226224
[Test-Path](Test-Path.md)
227-

0 commit comments

Comments
 (0)