Skip to content

Commit b6d08f9

Browse files
authored
Markdown and PS Styles (#11751)
* Markdown and PS Styles * additional fix links path case
1 parent cab9e80 commit b6d08f9

22 files changed

+115
-96
lines changed

reference/7.5/Microsoft.PowerShell.Core/New-PSSessionOption.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,9 @@ remote session, including startup scripts in the session configuration, can find
272272
the **ApplicationArguments** property of the `$PSSenderInfo` automatic variable. You can use this
273273
parameter to send data to the remote session.
274274

275-
For more information, see [about_Hash_Tables](about/about_Hash_Tables.md),
275+
For more information, see [about_Hash_Tables](About/about_Hash_Tables.md),
276276
[about_Session_Configurations](About/about_Session_Configurations.md), and
277-
[about_Automatic_Variables](about/about_Automatic_Variables.md).
277+
[about_Automatic_Variables](About/about_Automatic_Variables.md).
278278

279279
```yaml
280280
Type: System.Management.Automation.PSPrimitiveDictionary
@@ -339,7 +339,7 @@ The idle time-out value is of significant importance if you intend to disconnect
339339
session. You can reconnect only if the session has not timed out.
340340

341341
Enter a value in milliseconds. The minimum value is `60000` (1 minute). The maximum is the value of
342-
the **MaxIdleTimeoutms** property of the session configuration. The default value, `-1`, does not
342+
the **MaxIdleTimeoutMs** property of the session configuration. The default value, `-1`, does not
343343
set an idle time-out.
344344

345345
The session uses the idle time-out that is set in the session options, if any. If none is set

reference/7.5/Microsoft.PowerShell.Core/New-PSTransportOption.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ session configuration is 40.
128128

129129
### Example 3: Setting a transport option
130130

131-
This command shows the effect of setting a transport option in a session configuration on the sessions that use the session configuration.
131+
This command shows the effect of setting a transport option in a session configuration on the
132+
sessions that use the session configuration.
132133

133134
```powershell
134135
$t = New-PSTransportOption -IdleTimeoutSec 3600
@@ -245,8 +246,8 @@ Accept wildcard characters: False
245246
246247
### -MaxIdleTimeoutSec
247248
248-
Limits the idle time-out set for each session to the specified value. The default value is `[Int]::MaxValue`
249-
(~25 days).
249+
Limits the idle time-out set for each session to the specified value. The default value is
250+
`[Int]::MaxValue` (~25 days).
250251

251252
The idle time-out value is of significant importance when the user intends to disconnect and
252253
reconnect to a session. The user can reconnect only if the session has not timed out.
@@ -400,7 +401,8 @@ Accept wildcard characters: False
400401
401402
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
402403
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
403-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
404+
-WarningAction, and -WarningVariable. For more information, see
405+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
404406
405407
## INPUTS
406408

reference/7.5/Microsoft.PowerShell.Core/Out-Default.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ transforms the objects into a stream of Formatting records (driven by the data i
3636
definition) and `Out-Host` transforms the formatting records into calls on the Host interface.
3737

3838
This cmdlet isn't intended to be used by the end user. Other cmdlets are recommended for controlling
39-
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the [Format.ps1xml](About/about_format.ps1xml.md)
40-
file to control formatting.
39+
output like [Out-Host](Out-Host.md) or using `Format-*` cmdlets and the
40+
[Format.ps1xml](About/about_Format.ps1xml.md) file to control formatting.
4141

4242
## EXAMPLES
4343

@@ -100,7 +100,8 @@ Accept wildcard characters: False
100100
101101
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
102102
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
103-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
103+
-WarningAction, and -WarningVariable. For more information, see
104+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
104105
105106
## INPUTS
106107

reference/7.5/Microsoft.PowerShell.Core/Out-Host.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,8 @@ Accept wildcard characters: False
117117

118118
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
119119
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
120-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
120+
-WarningAction, and -WarningVariable. For more information, see
121+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
121122

122123
## INPUTS
123124

reference/7.5/Microsoft.PowerShell.Core/Out-Null.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ Accept wildcard characters: False
5757
5858
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
5959
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
60-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
60+
-WarningAction, and -WarningVariable. For more information, see
61+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
6162
6263
## INPUTS
6364

reference/7.5/Microsoft.PowerShell.Core/Receive-Job.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ When you start a PowerShell background job, the job starts, but the results don'
6767
immediately. Instead, the command returns an object that represents the background job. The job
6868
object contains useful information about the job, but it doesn't contain the results. This method
6969
lets you continue to work in the session while the job runs. For more information about background
70-
jobs in PowerShell, see [about_Jobs](./About/about_Jobs.md).
70+
jobs in PowerShell, see [about_Jobs](About/about_Jobs.md).
7171

7272
The `Receive-Job` cmdlet gets the results that have been generated by the time that the
7373
`Receive-Job` command is submitted. If the results aren't yet complete, you can run additional
@@ -592,7 +592,7 @@ Accept wildcard characters: False
592592
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
593593
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
594594
-WarningAction, and -WarningVariable. For more information, see
595-
[about_CommonParameters](./About/about_CommonParameters.md).
595+
[about_CommonParameters](About/about_CommonParameters.md).
596596

597597
## INPUTS
598598

reference/7.5/Microsoft.PowerShell.Core/Receive-PSSession.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ If you use the `Receive-PSSession` cmdlet to connect to a session in which no co
104104
or suspended, `Receive-PSSession` connects to the session, but returns no output or errors.
105105

106106
For more information about the Disconnected Sessions feature, see
107-
[about_Remote_Disconnected_Sessions](./About/about_Remote_Disconnected_Sessions.md).
107+
[about_Remote_Disconnected_Sessions](About/about_Remote_Disconnected_Sessions.md).
108108

109109
Some examples use splatting to reduce the line length and improve readability. For more information,
110-
see [about_Splatting](./About/about_Splatting.md).
110+
see [about_Splatting](About/about_Splatting.md).
111111

112112
## EXAMPLES
113113

@@ -179,7 +179,7 @@ disrupts a session connection. PowerShell automatically attempts to reconnect th
179179
second for the next four minutes and abandons the effort only if all attempts in the four-minute
180180
interval fail.
181181

182-
```
182+
```powershell
183183
PS> $s = New-PSSession -ComputerName Server01 -Name AD -ConfigurationName ADEndpoint
184184
PS> $s
185185
@@ -248,7 +248,7 @@ commands. And, the script resumed execution and is getting the script results.
248248
This example uses the `Receive-PSSession` cmdlet to reconnect to sessions that were intentionally
249249
disconnected and get the results of jobs that were running in the sessions.
250250

251-
```
251+
```powershell
252252
PS> $parms = @{
253253
InDisconnectedSession = $True
254254
ComputerName = "Server01", "Server02", "Server30"
@@ -318,7 +318,7 @@ results are unexpected, the user can run commands in the sessions to investigate
318318

319319
This example shows what happens to a job that's running in a disconnected session.
320320

321-
```
321+
```powershell
322322
PS> $s = New-PSSession -ComputerName Server01 -Name Test
323323
PS> $j = Invoke-Command -Session $s { 1..1500 | Foreach-Object {"Return $_"; sleep 30}} -AsJob
324324
PS> $j
@@ -533,7 +533,7 @@ The parameter's value is used to select and filter sessions. It doesn't change t
533533
configuration that the session uses.
534534

535535
For more information about session configurations, see
536-
[about_Session_Configurations](./About/about_Session_Configurations.md).
536+
[about_Session_Configurations](About/about_Session_Configurations.md).
537537

538538
```yaml
539539
Type: System.String
@@ -786,9 +786,8 @@ precedence over maximum values, quotas, or limits set in the session configurati
786786

787787
For a description of the session options that includes the default values, see
788788
`New-PSSessionOption`. For information about the **$PSSessionOption** preference variable, see
789-
[about_Preference_Variables](./About/about_Preference_Variables.md). For more information about
790-
session configurations, see
791-
[about_Session_Configurations](./About/about_Session_Configurations.md).
789+
[about_Preference_Variables](About/about_Preference_Variables.md). For more information about
790+
session configurations, see [about_Session_Configurations](About/about_Session_Configurations.md).
792791

793792
```yaml
794793
Type: System.Management.Automation.Remoting.PSSessionOption
@@ -977,13 +976,13 @@ When you disconnect a **PSSession**, the session state is Disconnected and the a
977976

978977
## RELATED LINKS
979978

980-
[about_PSSessions](./About/about_PSSessions.md)
979+
[about_PSSessions](About/about_PSSessions.md)
981980

982-
[about_Remote](./About/about_Remote.md)
981+
[about_Remote](About/about_Remote.md)
983982

984-
[about_Remote_Disconnected_Sessions](./About/about_Remote_Disconnected_Sessions.md)
983+
[about_Remote_Disconnected_Sessions](About/about_Remote_Disconnected_Sessions.md)
985984

986-
[about_Session_Configurations](./About/about_Session_Configurations.md)
985+
[about_Session_Configurations](About/about_Session_Configurations.md)
987986

988987
[Connect-PSSession](Connect-PSSession.md)
989988

reference/7.5/Microsoft.PowerShell.Core/Register-ArgumentCompleter.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ Specifies the name of the parameter the argument completer applies to. The type
226226
parameters can't be an enumeration, such as the **ForegroundColor** parameter of the `Write-Host`
227227
cmdlet.
228228

229-
For more information on enums, see [about_Enum](./About/about_Enum.md).
229+
For more information on enums, see [about_Enum](About/about_Enum.md).
230230

231231
When registering an argument completer for PowerShell commands, always specify this parameter. When
232232
you specify the **CommandName** parameter without the **ParameterName** or **Native** parameters,
@@ -272,7 +272,7 @@ parameters aren't important because PowerShell passes in the values by position.
272272
[CommandAst Class](/dotnet/api/system.management.automation.language.commandast).
273273
- `$fakeBoundParameters` (Position 4 **IDictionary**) - This parameter is set to a hashtable
274274
containing the `$PSBoundParameters` for the cmdlet, before the user pressed <kbd>Tab</kbd>. For
275-
more information, see [about_Automatic_Variables](./About/about_Automatic_Variables.md).
275+
more information, see [about_Automatic_Variables](About/about_Automatic_Variables.md).
276276

277277
When you specify the **Native** parameter, the script block must take the following parameters in
278278
the specified order. The names of the parameters aren't important because PowerShell passes in the
@@ -288,7 +288,7 @@ values by position.
288288
when the user pressed <kbd>Tab</kbd>.
289289

290290
You can also provide an **ArgumentCompleter** as a parameter attribute. For more information, see
291-
[about_Functions_Advanced_Parameters](./About/about_Functions_Advanced_Parameters.md).
291+
[about_Functions_Advanced_Parameters](About/about_Functions_Advanced_Parameters.md).
292292

293293
```yaml
294294
Type: System.Management.Automation.ScriptBlock
@@ -307,7 +307,7 @@ Accept wildcard characters: False
307307
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
308308
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
309309
-WarningAction, and -WarningVariable. For more information, see
310-
[about_CommonParameters](./About/about_CommonParameters.md).
310+
[about_CommonParameters](About/about_CommonParameters.md).
311311

312312
## INPUTS
313313

@@ -325,4 +325,4 @@ This cmdlet returns no output.
325325

326326
## RELATED LINKS
327327

328-
[about_Functions_Argument_Completion](./About/about_Functions_Argument_Completion.md)
328+
[about_Functions_Argument_Completion](About/about_Functions_Argument_Completion.md)

reference/7.5/Microsoft.PowerShell.Core/Register-PSSessionConfiguration.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,9 @@ This example registers the **AdminShell** session configuration.
120120

121121
The `$sessionParams` variable is a hashtable containing all the parameter values. This hashtable is
122122
passed to the cmdlet using PowerShell splatting. The `Register-PSSessionConfiguration` command uses
123-
the **SecurityDescriptorSDDL** parameter to specify the SDDL in the value of the `$sddl` variable and
124-
the **MaximumReceivedObjectSizeMB** parameter to increase the object size limit. It also uses the
125-
**StartupScript** parameter to specify a script that configures the session.
123+
the **SecurityDescriptorSDDL** parameter to specify the SDDL in the value of the `$sddl` variable
124+
and the **MaximumReceivedObjectSizeMB** parameter to increase the object size limit. It also uses
125+
the **StartupScript** parameter to specify a script that configures the session.
126126

127127
```powershell
128128
$sddl = "O:NSG:BAD:P(A;;GA;;;BA)S:P(AU;FA;GA;;;WD)(AU;FASA;GWGX;;;WD)"
@@ -181,8 +181,8 @@ Register-PSSessionConfiguration -Name WithProfile -StartupScript Add-Profile.ps1
181181
The script contains a single command that uses dot sourcing to run the user's
182182
**CurrentUserAllHosts** profile in the current scope of the session.
183183

184-
For more information about profiles, see [about_Profiles](./About/about_Profiles.md). For more
185-
information about dot sourcing, see [about_Scopes](./About/about_Scopes.md).
184+
For more information about profiles, see [about_Profiles](About/about_Profiles.md). For more
185+
information about dot sourcing, see [about_Scopes](About/about_Scopes.md).
186186

187187
## PARAMETERS
188188

@@ -626,7 +626,8 @@ for this parameter are:
626626

627627
The default value is **UseCurrentThread**.
628628

629-
For more information, see [PSThreadOptions Enumeration](/dotnet/api/system.management.automation.runspaces.psthreadoptions?view=powershellsdk-1.1.0).
629+
For more information, see
630+
[PSThreadOptions Enumeration](/dotnet/api/system.management.automation.runspaces.psthreadoptions?view=powershellsdk-1.1.0).
630631

631632
```yaml
632633
Type: System.Management.Automation.Runspaces.PSThreadOptions
@@ -714,7 +715,8 @@ Accept wildcard characters: False
714715

715716
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
716717
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
717-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
718+
-WarningAction, and -WarningVariable. For more information, see
719+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
718720

719721
## INPUTS
720722

reference/7.5/Microsoft.PowerShell.Core/Remove-Job.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ An alternative is to use the **Job** parameter, such as `Remove-Job -Job $batch`
9898
In this example, all the jobs in the current PowerShell session are deleted.
9999

100100
```powershell
101-
Get-job | Remove-Job
101+
Get-Job | Remove-Job
102102
```
103103

104104
`Get-Job` gets all the jobs in the current PowerShell session. The job objects are sent down the
@@ -116,7 +116,7 @@ Remove-Job -State NotStarted
116116

117117
### Example 4: Delete jobs by using a friendly name
118118

119-
This example deletes all jobs from the current session with friendly names that end with *batch**,
119+
This example deletes all jobs from the current session with friendly names that end with **batch**,
120120
including jobs that are running.
121121

122122
```powershell
@@ -410,7 +410,8 @@ Accept wildcard characters: False
410410

411411
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
412412
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
413-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
413+
-WarningAction, and -WarningVariable. For more information, see
414+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
414415

415416
## INPUTS
416417

@@ -438,11 +439,11 @@ If a job stops before completion and its process hasn't exited, the process is f
438439

439440
## RELATED LINKS
440441

441-
[about_Jobs](./About/about_Jobs.md)
442+
[about_Jobs](About/about_Jobs.md)
442443

443-
[about_Job_Details](./About/about_Job_Details.md)
444+
[about_Job_Details](About/about_Job_Details.md)
444445

445-
[about_Remote_Jobs](./About/about_Remote_Jobs.md)
446+
[about_Remote_Jobs](About/about_Remote_Jobs.md)
446447

447448
[Get-Job](Get-Job.md)
448449

reference/7.5/Microsoft.PowerShell.Core/Remove-PSSession.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,12 @@ with `Serv`.
110110
### Example 4: Close sessions connected to a port
111111

112112
```powershell
113-
Get-PSSession | where {$_.port -eq 90} | Remove-PSSession
113+
Get-PSSession | Where-Object {$_.port -eq 90} | Remove-PSSession
114114
```
115115

116116
This command closes the **PSSessions** that are connected to port 90. You can use this command
117-
format to identify **PSSessions** by properties other than **ComputerName**, **Name**, **InstanceID**, and
118-
**ID**.
117+
format to identify **PSSessions** by properties other than **ComputerName**, **Name**,
118+
**InstanceID**, and **ID**.
119119

120120
### Example 5: Close a session by instance ID
121121

@@ -358,7 +358,8 @@ Accept wildcard characters: False
358358

359359
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
360360
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
361-
-WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
361+
-WarningAction, and -WarningVariable. For more information, see
362+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
362363

363364
## INPUTS
364365

0 commit comments

Comments
 (0)