Skip to content

Commit d231e6d

Browse files
Merge pull request #12585 from MicrosoftDocs/main
Auto Publish – main to live - 2025-12-15 23:00 UTC
2 parents dd545ad + 9bb4ea3 commit d231e6d

File tree

10 files changed

+96
-65
lines changed

10 files changed

+96
-65
lines changed

.gitignore

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ _themes/
44
.openpublishing.build.mdproj
55
.openpublishing.buildcore.ps1
66
.optemp/
7+
.vale/
78
*.orig
89
**/.ignore/**
10+
**/settings.json
911
dependentPackages/
1012
log/
1113
maml/
1214
obj/
1315
packages.config
1416
packages/
17+
StaleContentReport.*.csv
1518
Tools/NuGet/
1619
updatablehelp/
1720
xhtml/
18-
**/settings.json
19-
StaleContentReport.*.csv
20-
.vale/

.vscode/extensions.json

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55
"Acrolinx.vscode-sidebar",
66
"docsmsft.docs-authoring-pack",
77
"marvhen.reflow-markdown",
8+
"chrischinchilla.vale-vscode",
89
"ms-vscode.powershell",
10+
"nhoizey.gremlins",
911
"shuworks.vscode-table-formatter",
12+
"bierner.markdown-yaml-preamble",
1013
"streetsidesoftware.code-spell-checker",
11-
"wmaurer.change-case",
12-
"yzane.markdown-pdf"
14+
"usernamehw.errorlens",
15+
"wmaurer.change-case"
1316
]
1417
}

reference/5.1/Microsoft.PowerShell.Core/About/about_Jobs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
description: Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session.
33
Locale: en-US
4-
ms.date: 01/07/2025
4+
ms.date: 12/15/2025
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-5.1&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_Jobs
88
---
99
# about_Jobs
1010

1111
## Short description
12+
1213
Provides information about how PowerShell background jobs run a command or
1314
expression in the background without interacting with the current session.
1415

@@ -239,12 +240,12 @@ Id Name PSJobTypeName State HasMoreData Location Command
239240
In this case, the **State** property reveals that Job 2 is still running. If
240241
you were to use the `Receive-Job` cmdlet to get the job results now, the
241242
results would be incomplete. You can use the `Receive-Job` cmdlet repeatedly to
242-
get all of the results. Use the **State** property to determine when the job is
243+
get all the results. Use the **State** property to determine when the job is
243244
complete.
244245

245-
You can also use the **Wait** parameter of the `Receive-Job` cmdlet. When you
246-
use this parameter, the cmdlet doesn't return the command prompt until the job
247-
is completed and all results are available.
246+
You can also the `Receive-Job -Wait` command. When you use this parameter, the
247+
cmdlet doesn't return the command prompt until the job is completed and all
248+
results are available.
248249

249250
You can also use the `Wait-Job` cmdlet to wait for any or all of the results of
250251
the job. `Wait-Job` lets you wait for one or more specific job or for all jobs.

reference/5.1/Microsoft.PowerShell.Core/Get-Help.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 06/21/2023
5+
ms.date: 12/15/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-5.1&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-Help
@@ -255,10 +255,9 @@ Export-Clixml
255255
Import-Clixml
256256
```
257257

258-
`Get-Help` uses the **Full** parameter to get help information for `Add-Member`. The
259-
**MamlCommandHelpInfo** object is sent down the pipeline. `Out-String` uses the **Stream** parameter
260-
to convert the object into a string. `Select-String` uses the **Pattern** parameter to search the
261-
string for **Clixml**.
258+
`Get-Help` uses the **Full** parameter to get help information for `Add-Member` and returns a
259+
**MamlCommandHelpInfo**. `Out-String` uses the **Stream** parameter to convert the object into a
260+
string. `Select-String` uses the **Pattern** parameter to search the string for **Clixml**.
262261

263262
### Example 10: Display a list of articles that include a word
264263

@@ -655,6 +654,13 @@ can also use it to update the help files so that the help on your computer is ne
655654
You can also read the help articles about the commands that come with PowerShell online starting at
656655
[Getting Started with Windows PowerShell](/powershell/scripting/getting-started/getting-started-with-windows-powershell).
657656

657+
You can use `Get-Help` to search for help articles by keyword or wildcard pattern. `Get-Help`
658+
displays a list of the matching articles. If the search term matches an approved verb, `Get-Help`
659+
displays a list of commands that use that verb. It doesn't include other help articles that include
660+
the matching search term. If the search term doesn't match an approved verb, `Get-Help` displays
661+
a list of articles that include that text in their contents. For more information about approved
662+
verbs, see [Get-Verb](xref:Microsoft.PowerShell.Utility.Get-Verb).
663+
658664
`Get-Help` displays help in the locale set for the Windows operating system or in the fallback
659665
language for that locale. If you don't have help files for the primary or fallback locale,
660666
`Get-Help` behaves as if there are no help files on the computer. To get help for a different

reference/7.4/Microsoft.PowerShell.Core/About/about_Jobs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
description: Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session.
33
Locale: en-US
4-
ms.date: 01/07/2025
4+
ms.date: 12/15/2025
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-7.4&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_Jobs
88
---
99
# about_Jobs
1010

1111
## Short description
12+
1213
Provides information about how PowerShell background jobs run a command or
1314
expression in the background without interacting with the current session.
1415

@@ -250,12 +251,12 @@ Id Name PSJobTypeName State HasMoreData Location Command
250251
In this case, the **State** property reveals that Job 2 is still running. If
251252
you were to use the `Receive-Job` cmdlet to get the job results now, the
252253
results would be incomplete. You can use the `Receive-Job` cmdlet repeatedly to
253-
get all of the results. Use the **State** property to determine when the job is
254+
get all the results. Use the **State** property to determine when the job is
254255
complete.
255256

256-
You can also use the **Wait** parameter of the `Receive-Job` cmdlet. When you
257-
use this parameter, the cmdlet doesn't return the command prompt until the job
258-
is completed and all results are available.
257+
You can also the `Receive-Job -Wait` command. When you use this parameter, the
258+
cmdlet doesn't return the command prompt until the job is completed and all
259+
results are available.
259260

260261
You can also use the `Wait-Job` cmdlet to wait for any or all of the results of
261262
the job. `Wait-Job` lets you wait for one or more specific job or for all jobs.

reference/7.4/Microsoft.PowerShell.Core/Get-Help.md

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 01/10/2024
5+
ms.date: 12/15/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.4&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-Help
@@ -100,8 +100,8 @@ fallback locale, it looks for help articles in English, **en-US**, before it ret
100100
message or displaying autogenerated help.
101101

102102
For information about the symbols that `Get-Help` displays in the command syntax diagram, see
103-
[about_Command_Syntax](./About/about_Command_Syntax.md). For information about parameter attributes,
104-
such as **Required** and **Position**, see [about_Parameters](./About/about_Parameters.md).
103+
[about_Command_Syntax](About/about_Command_Syntax.md). For information about parameter attributes,
104+
such as **Required** and **Position**, see [about_Parameters](About/about_Parameters.md).
105105

106106
> [!NOTE]
107107
> In PowerShell 3.0 and PowerShell 4.0, `Get-Help` can't find **About** articles in modules unless
@@ -118,10 +118,10 @@ immediately to the left of a parameter, the function jumps to that parameter's d
118118
full help topic. When you hit <kbd>Q</kbd> to exit the help view, you are returned to the command
119119
line at the same cursor position so you can continue typing the command.
120120

121-
When you use the key combination <kbd>Alt</kbd>+<kbd>h</kbd>, the **PSReadLine** `ShowParameterHelp` function
122-
displays help information for the parameter immediately to the left of the cursor. The help text is
123-
displayed below the command line. This allows you to see the description of the parameter and
124-
continue typing your command.
121+
When you use the key combination <kbd>Alt</kbd>+<kbd>h</kbd>, the **PSReadLine** `ShowParameterHelp`
122+
function displays help information for the parameter immediately to the left of the cursor. The help
123+
text is displayed below the command line. This allows you to see the description of the parameter
124+
and continue typing your command.
125125

126126
For more information, see [Using dynamic help](/powershell/scripting/learn/shell/dynamic-help).
127127

@@ -255,10 +255,9 @@ Export-Clixml
255255
Import-Clixml
256256
```
257257

258-
`Get-Help` uses the **Full** parameter to get help information for `Add-Member`. The
259-
**MamlCommandHelpInfo** object is sent down the pipeline. `Out-String` uses the **Stream** parameter
260-
to convert the object into a string. `Select-String` uses the **Pattern** parameter to search the
261-
string for **Clixml**.
258+
`Get-Help` uses the **Full** parameter to get help information for `Add-Member` and returns a
259+
**MamlCommandHelpInfo**. `Out-String` uses the **Stream** parameter to convert the object into a
260+
string. `Select-String` uses the **Pattern** parameter to search the string for **Clixml**.
262261

263262
### Example 10: Display a list of articles that include a word
264263

@@ -329,7 +328,7 @@ SYNOPSIS
329328
### Example 12: Display help for a script
330329

331330
This example gets help for the `MyScript.ps1 script`. For information about how to write help for
332-
your functions and scripts, see [about_Comment_Based_Help](./About/about_Comment_Based_Help.md).
331+
your functions and scripts, see [about_Comment_Based_Help](About/about_Comment_Based_Help.md).
333332

334333
```powershell
335334
Get-Help -Name C:\PS-Test\MyScript.ps1
@@ -505,7 +504,7 @@ for cmdlet, function, workflow, and script help articles. You can't use the **On
505504
with `Get-Help` in a remote session.
506505

507506
For information about supporting this feature in help articles that you write, see
508-
[about_Comment_Based_Help](./About/about_Comment_Based_Help.md), and
507+
[about_Comment_Based_Help](About/about_Comment_Based_Help.md), and
509508
[Supporting Online Help](/powershell/scripting/developer/module/supporting-online-help), and
510509
[Writing Help for PowerShell Cmdlets](/powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets).
511510

@@ -554,7 +553,7 @@ To see the custom cmdlet help for a provider path, go to the provider path locat
554553
the provider path. You can also find custom cmdlet help online in the provider help section of the
555554
help articles.
556555

557-
For more information about PowerShell providers, see [about_Providers](./About/about_Providers.md).
556+
For more information about PowerShell providers, see [about_Providers](About/about_Providers.md).
558557

559558
> [!NOTE]
560559
> The provider for the path specified must have a PowerShell provider help file installed. If no
@@ -655,6 +654,13 @@ can also use it to update the help files so that the help on your computer is ne
655654
You can also read the help articles about the commands that come with PowerShell online starting at
656655
[Getting Started with Windows PowerShell](/powershell/scripting/getting-started/getting-started-with-windows-powershell).
657656

657+
You can use `Get-Help` to search for help articles by keyword or wildcard pattern. `Get-Help`
658+
displays a list of the matching articles. If the search term matches an approved verb, `Get-Help`
659+
displays a list of commands that use that verb. It doesn't include other help articles that include
660+
the matching search term. If the search term doesn't match an approved verb, `Get-Help` displays
661+
a list of articles that include that text in their contents. For more information about approved
662+
verbs, see [Get-Verb](xref:Microsoft.PowerShell.Utility.Get-Verb).
663+
658664
`Get-Help` displays help in the locale set for the Windows operating system or in the fallback
659665
language for that locale. If you don't have help files for the primary or fallback locale,
660666
`Get-Help` behaves as if there are no help files on the computer. To get help for a different
@@ -691,7 +697,7 @@ following fields:
691697

692698
[about_Command_Syntax](About/about_Command_Syntax.md)
693699

694-
[about_Comment_Based_Help](./About/about_Comment_Based_Help.md)
700+
[about_Comment_Based_Help](About/about_Comment_Based_Help.md)
695701

696702
[Get-Command](Get-Command.md)
697703

reference/7.5/Microsoft.PowerShell.Core/About/about_Jobs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
description: Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session.
33
Locale: en-US
4-
ms.date: 01/07/2025
4+
ms.date: 12/15/2025
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-7.5&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_Jobs
88
---
99
# about_Jobs
1010

1111
## Short description
12+
1213
Provides information about how PowerShell background jobs run a command or
1314
expression in the background without interacting with the current session.
1415

@@ -250,12 +251,12 @@ Id Name PSJobTypeName State HasMoreData Location Command
250251
In this case, the **State** property reveals that Job 2 is still running. If
251252
you were to use the `Receive-Job` cmdlet to get the job results now, the
252253
results would be incomplete. You can use the `Receive-Job` cmdlet repeatedly to
253-
get all of the results. Use the **State** property to determine when the job is
254+
get all the results. Use the **State** property to determine when the job is
254255
complete.
255256

256-
You can also use the **Wait** parameter of the `Receive-Job` cmdlet. When you
257-
use this parameter, the cmdlet doesn't return the command prompt until the job
258-
is completed and all results are available.
257+
You can also the `Receive-Job -Wait` command. When you use this parameter, the
258+
cmdlet doesn't return the command prompt until the job is completed and all
259+
results are available.
259260

260261
You can also use the `Wait-Job` cmdlet to wait for any or all of the results of
261262
the job. `Wait-Job` lets you wait for one or more specific job or for all jobs.

reference/7.5/Microsoft.PowerShell.Core/Get-Help.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
external help file: System.Management.Automation.dll-Help.xml
33
Locale: en-US
44
Module Name: Microsoft.PowerShell.Core
5-
ms.date: 01/10/2024
5+
ms.date: 12/15/2025
66
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.5&WT.mc_id=ps-gethelp
77
schema: 2.0.0
88
title: Get-Help
@@ -255,10 +255,9 @@ Export-Clixml
255255
Import-Clixml
256256
```
257257

258-
`Get-Help` uses the **Full** parameter to get help information for `Add-Member`. The
259-
**MamlCommandHelpInfo** object is sent down the pipeline. `Out-String` uses the **Stream** parameter
260-
to convert the object into a string. `Select-String` uses the **Pattern** parameter to search the
261-
string for **Clixml**.
258+
`Get-Help` uses the **Full** parameter to get help information for `Add-Member` and returns a
259+
**MamlCommandHelpInfo**. `Out-String` uses the **Stream** parameter to convert the object into a
260+
string. `Select-String` uses the **Pattern** parameter to search the string for **Clixml**.
262261

263262
### Example 10: Display a list of articles that include a word
264263

@@ -655,6 +654,13 @@ can also use it to update the help files so that the help on your computer is ne
655654
You can also read the help articles about the commands that come with PowerShell online starting at
656655
[Getting Started with Windows PowerShell](/powershell/scripting/getting-started/getting-started-with-windows-powershell).
657656

657+
You can use `Get-Help` to search for help articles by keyword or wildcard pattern. `Get-Help`
658+
displays a list of the matching articles. If the search term matches an approved verb, `Get-Help`
659+
displays a list of commands that use that verb. It doesn't include other help articles that include
660+
the matching search term. If the search term doesn't match an approved verb, `Get-Help` displays
661+
a list of articles that include that text in their contents. For more information about approved
662+
verbs, see [Get-Verb](xref:Microsoft.PowerShell.Utility.Get-Verb).
663+
658664
`Get-Help` displays help in the locale set for the Windows operating system or in the fallback
659665
language for that locale. If you don't have help files for the primary or fallback locale,
660666
`Get-Help` behaves as if there are no help files on the computer. To get help for a different

reference/7.6/Microsoft.PowerShell.Core/About/about_Jobs.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
22
description: Provides information about how PowerShell background jobs run a command or expression in the background without interacting with the current session.
33
Locale: en-US
4-
ms.date: 01/07/2025
4+
ms.date: 12/15/2025
55
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_jobs?view=powershell-7.6&WT.mc_id=ps-gethelp
66
schema: 2.0.0
77
title: about_Jobs
88
---
99
# about_Jobs
1010

1111
## Short description
12+
1213
Provides information about how PowerShell background jobs run a command or
1314
expression in the background without interacting with the current session.
1415

@@ -250,12 +251,12 @@ Id Name PSJobTypeName State HasMoreData Location Command
250251
In this case, the **State** property reveals that Job 2 is still running. If
251252
you were to use the `Receive-Job` cmdlet to get the job results now, the
252253
results would be incomplete. You can use the `Receive-Job` cmdlet repeatedly to
253-
get all of the results. Use the **State** property to determine when the job is
254+
get all the results. Use the **State** property to determine when the job is
254255
complete.
255256

256-
You can also use the **Wait** parameter of the `Receive-Job` cmdlet. When you
257-
use this parameter, the cmdlet doesn't return the command prompt until the job
258-
is completed and all results are available.
257+
You can also the `Receive-Job -Wait` command. When you use this parameter, the
258+
cmdlet doesn't return the command prompt until the job is completed and all
259+
results are available.
259260

260261
You can also use the `Wait-Job` cmdlet to wait for any or all of the results of
261262
the job. `Wait-Job` lets you wait for one or more specific job or for all jobs.

0 commit comments

Comments
 (0)