diff --git a/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index f1b2f6f0efbb..142e7c5ae2c1 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/5.1/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -1,7 +1,7 @@ --- description: Describes how to write comment-based help content for functions and scripts. Locale: en-US -ms.date: 01/09/2025 +ms.date: 05/21/2025 no-loc: [.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE, .INPUTS, .OUTPUTS, .NOTES, .LINK, .COMPONENT, .ROLE, .FUNCTIONALITY, .FORWARDHELPTARGETNAME, .FORWARDHELPCATEGORY, .REMOTEHELPRUNSPACE, .EXTERNALHELP] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-5.1&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -227,58 +227,54 @@ function Verb-Noun { } ``` -### .EXAMPLE +### `.EXAMPLE` A sample command that uses the function or script, optionally followed by sample output and a description. Repeat this keyword for each example. -### .INPUTS +### `.INPUTS` The .NET types of objects that can be piped to the function or script. You can -also include a description of the input objects. +also include a description of the input objects. Repeat this keyword for each +input type. -### .OUTPUTS +### `.OUTPUTS` The .NET type of the objects that the cmdlet returns. You can also include a -description of the returned objects. +description of the returned objects. Repeat this keyword for each output type. -### .NOTES +### `.NOTES` Additional information about the function or script. -### .LINK +### `.LINK` -The name of a related topic. The value appears on the line below the ".LINK" -keyword and must be preceded by a comment symbol `#` or included in the -comment block. - -Repeat the `.LINK` keyword for each related topic. - -This content appears in the Related Links section of the help topic. +The name of a related topic. Repeat this keyword for each related topic. This +content appears in the Related Links section of the Help topic. The `.LINK` keyword content can also include a Uniform Resource Identifier (URI) to an online version of the same help topic. The online version opens when you use the **Online** parameter of `Get-Help`. The URI must begin with -"http" or "https". +`http` or `https`. -### .COMPONENT +### `.COMPONENT` The name of the technology or feature that the function or script uses, or to which it's related. The **Component** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .ROLE +### `.ROLE` The name of the user role for the help topic. The **Role** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FUNCTIONALITY +### `.FUNCTIONALITY` The keywords that describe the intended use of the function. The **Functionality** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FORWARDHELPTARGETNAME +### `.FORWARDHELPTARGETNAME ` Redirects to the help topic for the specified command. You can redirect users to any help topic, including help content for a function, script, cmdlet, or @@ -288,7 +284,7 @@ provider. # .FORWARDHELPTARGETNAME ``` -### .FORWARDHELPCATEGORY +### `.FORWARDHELPCATEGORY` Specifies the help category of the item in `.FORWARDHELPTARGETNAME`. Valid values are `Alias`, `Cmdlet`, `HelpFile`, `Function`, `Provider`, `General`, @@ -299,7 +295,7 @@ this keyword to avoid conflicts when there are commands with the same name. # .FORWARDHELPCATEGORY ``` -### .REMOTEHELPRUNSPACE +### `.REMOTEHELPRUNSPACE ` Specifies a session that contains the help topic. Enter a variable that contains a **PSSession** object. This keyword is used by the @@ -310,7 +306,7 @@ commands. # .REMOTEHELPRUNSPACE ``` -### .EXTERNALHELP +### `.EXTERNALHELP` Specifies an XML-based help file for the script or function. diff --git a/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md b/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md index c2145e2c5806..7e4fc8619f1a 100644 --- a/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/5.1/Microsoft.PowerShell.Core/Get-Module.md @@ -495,12 +495,9 @@ Accept wildcard characters: False ### -ListAvailable -Indicates that this cmdlet gets all installed modules. `Get-Module` gets modules in paths listed in -the **PSModulePath** environment variable. Without this parameter, `Get-Module` gets only the -modules that are both listed in the **PSModulePath** environment variable, and that are loaded in -the current session. **ListAvailable** does not return information about modules that are not found -in the **PSModulePath** environment variable, even if those modules are loaded in the current -session. +By default, `Get-Module` only returns the modules that have been imported into the current session. +With this parameter the command lists modules installed in any path included in the +`$env:PSModulePath` environment variable. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/reference/7.4/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/7.4/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index bd5f797d9a9a..8bc3e827c92e 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/7.4/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -1,7 +1,7 @@ --- description: Describes how to write comment-based help content for functions and scripts. Locale: en-US -ms.date: 01/09/2025 +ms.date: 05/21/2025 no-loc: [.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE, .INPUTS, .OUTPUTS, .NOTES, .LINK, .COMPONENT, .ROLE, .FUNCTIONALITY, .FORWARDHELPTARGETNAME, .FORWARDHELPCATEGORY, .REMOTEHELPRUNSPACE, .EXTERNALHELP] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.4&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -227,58 +227,54 @@ function Verb-Noun { } ``` -### .EXAMPLE +### `.EXAMPLE` A sample command that uses the function or script, optionally followed by sample output and a description. Repeat this keyword for each example. -### .INPUTS +### `.INPUTS` The .NET types of objects that can be piped to the function or script. You can -also include a description of the input objects. +also include a description of the input objects. Repeat this keyword for each +input type. -### .OUTPUTS +### `.OUTPUTS` The .NET type of the objects that the cmdlet returns. You can also include a -description of the returned objects. +description of the returned objects. Repeat this keyword for each output type. -### .NOTES +### `.NOTES` Additional information about the function or script. -### .LINK +### `.LINK` -The name of a related topic. The value appears on the line below the ".LINK" -keyword and must be preceded by a comment symbol `#` or included in the -comment block. - -Repeat the `.LINK` keyword for each related topic. - -This content appears in the Related Links section of the help topic. +The name of a related topic. Repeat this keyword for each related topic. This +content appears in the Related Links section of the Help topic. The `.LINK` keyword content can also include a Uniform Resource Identifier (URI) to an online version of the same help topic. The online version opens when you use the **Online** parameter of `Get-Help`. The URI must begin with -"http" or "https". +`http` or `https`. -### .COMPONENT +### `.COMPONENT` The name of the technology or feature that the function or script uses, or to which it's related. The **Component** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .ROLE +### `.ROLE` The name of the user role for the help topic. The **Role** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FUNCTIONALITY +### `.FUNCTIONALITY` The keywords that describe the intended use of the function. The **Functionality** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FORWARDHELPTARGETNAME +### `.FORWARDHELPTARGETNAME ` Redirects to the help topic for the specified command. You can redirect users to any help topic, including help content for a function, script, cmdlet, or @@ -288,7 +284,7 @@ provider. # .FORWARDHELPTARGETNAME ``` -### .FORWARDHELPCATEGORY +### `.FORWARDHELPCATEGORY` Specifies the help category of the item in `.FORWARDHELPTARGETNAME`. Valid values are `Alias`, `Cmdlet`, `HelpFile`, `Function`, `Provider`, `General`, @@ -299,7 +295,7 @@ this keyword to avoid conflicts when there are commands with the same name. # .FORWARDHELPCATEGORY ``` -### .REMOTEHELPRUNSPACE +### `.REMOTEHELPRUNSPACE ` Specifies a session that contains the help topic. Enter a variable that contains a **PSSession** object. This keyword is used by the @@ -310,7 +306,7 @@ commands. # .REMOTEHELPRUNSPACE ``` -### .EXTERNALHELP +### `.EXTERNALHELP` Specifies an XML-based help file for the script or function. diff --git a/reference/7.4/Microsoft.PowerShell.Core/Get-Module.md b/reference/7.4/Microsoft.PowerShell.Core/Get-Module.md index 3bb44ce89e40..aa7138e19474 100644 --- a/reference/7.4/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/7.4/Microsoft.PowerShell.Core/Get-Module.md @@ -496,12 +496,9 @@ Accept wildcard characters: False ### -ListAvailable -Indicates that this cmdlet gets all installed modules. `Get-Module` gets modules in paths listed in -the **PSModulePath** environment variable. Without this parameter, `Get-Module` gets only the -modules that are both listed in the **PSModulePath** environment variable, and that are loaded in -the current session. **ListAvailable** does not return information about modules that are not found -in the **PSModulePath** environment variable, even if those modules are loaded in the current -session. +By default, `Get-Module` only returns the modules that have been imported into the current session. +With this parameter the command lists modules installed in any path included in the +`$env:PSModulePath` environment variable. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Get-Random.md b/reference/7.4/Microsoft.PowerShell.Utility/Get-Random.md index fc04ce9d1f1a..8eafcff7ba78 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Get-Random.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Get-Random.md @@ -266,7 +266,7 @@ In this example, the **InputObject** parameter specifies an array that contains Get-Random -InputObject @('a','',$null) ``` -`Get-Random` returns either `a`, empty string, or `$null`. The empty sting displays as a blank line +`Get-Random` returns either `a`, empty string, or `$null`. The empty string displays as a blank line and `$null` returns to a PowerShell prompt. ## PARAMETERS diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Get-SecureRandom.md b/reference/7.4/Microsoft.PowerShell.Utility/Get-SecureRandom.md index cf72b0559b52..81f4bdcbbc2e 100644 --- a/reference/7.4/Microsoft.PowerShell.Utility/Get-SecureRandom.md +++ b/reference/7.4/Microsoft.PowerShell.Utility/Get-SecureRandom.md @@ -205,7 +205,7 @@ In this example, the **InputObject** parameter specifies an array that contains Get-SecureRandom -InputObject @('a','',$null) ``` -`Get-SecureRandom` returns either `a`, empty string, or `$null`. The empty sting displays as a blank +`Get-SecureRandom` returns either `a`, empty string, or `$null`. The empty string displays as a blank line and `$null` returns to a PowerShell prompt. ## PARAMETERS diff --git a/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index fc6bd349979b..7e9a1673092e 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -1,7 +1,7 @@ --- description: Describes how to write comment-based help content for functions and scripts. Locale: en-US -ms.date: 01/09/2025 +ms.date: 05/21/2025 no-loc: [.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE, .INPUTS, .OUTPUTS, .NOTES, .LINK, .COMPONENT, .ROLE, .FUNCTIONALITY, .FORWARDHELPTARGETNAME, .FORWARDHELPCATEGORY, .REMOTEHELPRUNSPACE, .EXTERNALHELP] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.5&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -227,58 +227,54 @@ function Verb-Noun { } ``` -### .EXAMPLE +### `.EXAMPLE` A sample command that uses the function or script, optionally followed by sample output and a description. Repeat this keyword for each example. -### .INPUTS +### `.INPUTS` The .NET types of objects that can be piped to the function or script. You can -also include a description of the input objects. +also include a description of the input objects. Repeat this keyword for each +input type. -### .OUTPUTS +### `.OUTPUTS` The .NET type of the objects that the cmdlet returns. You can also include a -description of the returned objects. +description of the returned objects. Repeat this keyword for each output type. -### .NOTES +### `.NOTES` Additional information about the function or script. -### .LINK +### `.LINK` -The name of a related topic. The value appears on the line below the ".LINK" -keyword and must be preceded by a comment symbol `#` or included in the -comment block. - -Repeat the `.LINK` keyword for each related topic. - -This content appears in the Related Links section of the help topic. +The name of a related topic. Repeat this keyword for each related topic. This +content appears in the Related Links section of the Help topic. The `.LINK` keyword content can also include a Uniform Resource Identifier (URI) to an online version of the same help topic. The online version opens when you use the **Online** parameter of `Get-Help`. The URI must begin with -"http" or "https". +`http` or `https`. -### .COMPONENT +### `.COMPONENT` The name of the technology or feature that the function or script uses, or to which it's related. The **Component** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .ROLE +### `.ROLE` The name of the user role for the help topic. The **Role** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FUNCTIONALITY +### `.FUNCTIONALITY` The keywords that describe the intended use of the function. The **Functionality** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FORWARDHELPTARGETNAME +### `.FORWARDHELPTARGETNAME ` Redirects to the help topic for the specified command. You can redirect users to any help topic, including help content for a function, script, cmdlet, or @@ -288,7 +284,7 @@ provider. # .FORWARDHELPTARGETNAME ``` -### .FORWARDHELPCATEGORY +### `.FORWARDHELPCATEGORY` Specifies the help category of the item in `.FORWARDHELPTARGETNAME`. Valid values are `Alias`, `Cmdlet`, `HelpFile`, `Function`, `Provider`, `General`, @@ -299,7 +295,7 @@ this keyword to avoid conflicts when there are commands with the same name. # .FORWARDHELPCATEGORY ``` -### .REMOTEHELPRUNSPACE +### `.REMOTEHELPRUNSPACE ` Specifies a session that contains the help topic. Enter a variable that contains a **PSSession** object. This keyword is used by the @@ -310,7 +306,7 @@ commands. # .REMOTEHELPRUNSPACE ``` -### .EXTERNALHELP +### `.EXTERNALHELP` Specifies an XML-based help file for the script or function. diff --git a/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md b/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md index e253f803558c..c0636f5b17d6 100644 --- a/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/7.5/Microsoft.PowerShell.Core/Get-Module.md @@ -496,12 +496,9 @@ Accept wildcard characters: False ### -ListAvailable -Indicates that this cmdlet gets all installed modules. `Get-Module` gets modules in paths listed in -the **PSModulePath** environment variable. Without this parameter, `Get-Module` gets only the -modules that are both listed in the **PSModulePath** environment variable, and that are loaded in -the current session. **ListAvailable** does not return information about modules that are not found -in the **PSModulePath** environment variable, even if those modules are loaded in the current -session. +By default, `Get-Module` only returns the modules that have been imported into the current session. +With this parameter the command lists modules installed in any path included in the +`$env:PSModulePath` environment variable. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Get-Random.md b/reference/7.5/Microsoft.PowerShell.Utility/Get-Random.md index 1441f72c035f..f9ed30770452 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Get-Random.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Get-Random.md @@ -266,7 +266,7 @@ In this example, the **InputObject** parameter specifies an array that contains Get-Random -InputObject @('a','',$null) ``` -`Get-Random` returns either `a`, empty string, or `$null`. The empty sting displays as a blank line +`Get-Random` returns either `a`, empty string, or `$null`. The empty string displays as a blank line and `$null` returns to a PowerShell prompt. ## PARAMETERS diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Get-SecureRandom.md b/reference/7.5/Microsoft.PowerShell.Utility/Get-SecureRandom.md index f68a702fdb65..2ddf6b3a23c8 100644 --- a/reference/7.5/Microsoft.PowerShell.Utility/Get-SecureRandom.md +++ b/reference/7.5/Microsoft.PowerShell.Utility/Get-SecureRandom.md @@ -205,7 +205,7 @@ In this example, the **InputObject** parameter specifies an array that contains Get-SecureRandom -InputObject @('a','',$null) ``` -`Get-SecureRandom` returns either `a`, empty string, or `$null`. The empty sting displays as a blank +`Get-SecureRandom` returns either `a`, empty string, or `$null`. The empty string displays as a blank line and `$null` returns to a PowerShell prompt. ## PARAMETERS diff --git a/reference/7.6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md b/reference/7.6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md index 5e0f3a32f83e..b0760b190ac0 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md +++ b/reference/7.6/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md @@ -1,7 +1,7 @@ --- description: Describes how to write comment-based help content for functions and scripts. Locale: en-US -ms.date: 01/09/2025 +ms.date: 05/21/2025 no-loc: [.SYNOPSIS, .DESCRIPTION, .PARAMETER, .EXAMPLE, .INPUTS, .OUTPUTS, .NOTES, .LINK, .COMPONENT, .ROLE, .FUNCTIONALITY, .FORWARDHELPTARGETNAME, .FORWARDHELPCATEGORY, .REMOTEHELPRUNSPACE, .EXTERNALHELP] online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.6&WT.mc_id=ps-gethelp schema: 2.0.0 @@ -227,58 +227,54 @@ function Verb-Noun { } ``` -### .EXAMPLE +### `.EXAMPLE` A sample command that uses the function or script, optionally followed by sample output and a description. Repeat this keyword for each example. -### .INPUTS +### `.INPUTS` The .NET types of objects that can be piped to the function or script. You can -also include a description of the input objects. +also include a description of the input objects. Repeat this keyword for each +input type. -### .OUTPUTS +### `.OUTPUTS` The .NET type of the objects that the cmdlet returns. You can also include a -description of the returned objects. +description of the returned objects. Repeat this keyword for each output type. -### .NOTES +### `.NOTES` Additional information about the function or script. -### .LINK +### `.LINK` -The name of a related topic. The value appears on the line below the ".LINK" -keyword and must be preceded by a comment symbol `#` or included in the -comment block. - -Repeat the `.LINK` keyword for each related topic. - -This content appears in the Related Links section of the help topic. +The name of a related topic. Repeat this keyword for each related topic. This +content appears in the Related Links section of the Help topic. The `.LINK` keyword content can also include a Uniform Resource Identifier (URI) to an online version of the same help topic. The online version opens when you use the **Online** parameter of `Get-Help`. The URI must begin with -"http" or "https". +`http` or `https`. -### .COMPONENT +### `.COMPONENT` The name of the technology or feature that the function or script uses, or to which it's related. The **Component** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .ROLE +### `.ROLE` The name of the user role for the help topic. The **Role** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FUNCTIONALITY +### `.FUNCTIONALITY` The keywords that describe the intended use of the function. The **Functionality** parameter of `Get-Help` uses this value to filter the search results returned by `Get-Help`. -### .FORWARDHELPTARGETNAME +### `.FORWARDHELPTARGETNAME ` Redirects to the help topic for the specified command. You can redirect users to any help topic, including help content for a function, script, cmdlet, or @@ -288,7 +284,7 @@ provider. # .FORWARDHELPTARGETNAME ``` -### .FORWARDHELPCATEGORY +### `.FORWARDHELPCATEGORY` Specifies the help category of the item in `.FORWARDHELPTARGETNAME`. Valid values are `Alias`, `Cmdlet`, `HelpFile`, `Function`, `Provider`, `General`, @@ -299,7 +295,7 @@ this keyword to avoid conflicts when there are commands with the same name. # .FORWARDHELPCATEGORY ``` -### .REMOTEHELPRUNSPACE +### `.REMOTEHELPRUNSPACE ` Specifies a session that contains the help topic. Enter a variable that contains a **PSSession** object. This keyword is used by the @@ -310,7 +306,7 @@ commands. # .REMOTEHELPRUNSPACE ``` -### .EXTERNALHELP +### `.EXTERNALHELP` Specifies an XML-based help file for the script or function. diff --git a/reference/7.6/Microsoft.PowerShell.Core/Get-Module.md b/reference/7.6/Microsoft.PowerShell.Core/Get-Module.md index 879712f7ffaa..086526918748 100644 --- a/reference/7.6/Microsoft.PowerShell.Core/Get-Module.md +++ b/reference/7.6/Microsoft.PowerShell.Core/Get-Module.md @@ -496,12 +496,9 @@ Accept wildcard characters: False ### -ListAvailable -Indicates that this cmdlet gets all installed modules. `Get-Module` gets modules in paths listed in -the **PSModulePath** environment variable. Without this parameter, `Get-Module` gets only the -modules that are both listed in the **PSModulePath** environment variable, and that are loaded in -the current session. **ListAvailable** does not return information about modules that are not found -in the **PSModulePath** environment variable, even if those modules are loaded in the current -session. +By default, `Get-Module` only returns the modules that have been imported into the current session. +With this parameter the command lists modules installed in any path included in the +`$env:PSModulePath` environment variable. ```yaml Type: System.Management.Automation.SwitchParameter diff --git a/reference/7.6/Microsoft.PowerShell.Utility/Get-Random.md b/reference/7.6/Microsoft.PowerShell.Utility/Get-Random.md index 75753bec2de9..4d38170744e4 100644 --- a/reference/7.6/Microsoft.PowerShell.Utility/Get-Random.md +++ b/reference/7.6/Microsoft.PowerShell.Utility/Get-Random.md @@ -266,7 +266,7 @@ In this example, the **InputObject** parameter specifies an array that contains Get-Random -InputObject @('a','',$null) ``` -`Get-Random` returns either `a`, empty string, or `$null`. The empty sting displays as a blank line +`Get-Random` returns either `a`, empty string, or `$null`. The empty string displays as a blank line and `$null` returns to a PowerShell prompt. ## PARAMETERS diff --git a/reference/7.6/Microsoft.PowerShell.Utility/Get-SecureRandom.md b/reference/7.6/Microsoft.PowerShell.Utility/Get-SecureRandom.md index 5599a2c73fc0..d0c8cf404658 100644 --- a/reference/7.6/Microsoft.PowerShell.Utility/Get-SecureRandom.md +++ b/reference/7.6/Microsoft.PowerShell.Utility/Get-SecureRandom.md @@ -205,7 +205,7 @@ In this example, the **InputObject** parameter specifies an array that contains Get-SecureRandom -InputObject @('a','',$null) ``` -`Get-SecureRandom` returns either `a`, empty string, or `$null`. The empty sting displays as a blank +`Get-SecureRandom` returns either `a`, empty string, or `$null`. The empty string displays as a blank line and `$null` returns to a PowerShell prompt. ## PARAMETERS diff --git a/reference/docs-conceptual/developer/help/comment-based-help-keywords.md b/reference/docs-conceptual/developer/help/comment-based-help-keywords.md index c1ae9c87ad2a..1cb7b8473e38 100644 --- a/reference/docs-conceptual/developer/help/comment-based-help-keywords.md +++ b/reference/docs-conceptual/developer/help/comment-based-help-keywords.md @@ -1,6 +1,6 @@ --- description: Comment-Based Help Keywords -ms.date: 07/10/2023 +ms.date: 05/21/2025 no-loc: [FAQ, Function, General, Glossary, Provider, Component, Functionality, Role] title: Comment-Based Help Keywords --- @@ -20,41 +20,46 @@ when it can't find a help file that matches the value of the keyword. ## `.SYNOPSIS` -A brief description of the function or script. This keyword can be used only once in each topic. +A brief description of the function or script. This keyword can be used only +once in each topic. ## `.DESCRIPTION` -A detailed description of the function or script. This keyword can be used only once in each topic. +A detailed description of the function or script. This keyword can be used only +once in each topic. ## `.PARAMETER ` -The description of a parameter. You can include a `.PARAMETER` keyword for each parameter in the -function or script. +The description of a parameter. You can include a `.PARAMETER` keyword for each +parameter in the function or script. -The `.PARAMETER` keywords can appear in any order in the comment block, but the order in which the -parameters appear in the `param` statement or function declaration determines the order in which the -parameters appear in Help topic. To change the order of parameters in the Help topic, change the -order of the parameters in the `param` statement or function declaration. +The `.PARAMETER` keywords can appear in any order in the comment block, but the +order in which the parameters appear in the `param` statement or function +declaration determines the order in which the parameters appear in Help topic. +To change the order of parameters in the Help topic, change the order of the +parameters in the `param` statement or function declaration. -You can also specify a parameter description by placing a comment in the `param` statement -immediately before the parameter variable name. If you use both a `param` statement comment and a -`.PARAMETER` keyword, the description associated with the `.PARAMETER` keyword is used, and the -`param` statement comment is ignored. +You can also specify a parameter description by placing a comment in the +`param` statement immediately before the parameter variable name. If you use +both a `param` statement comment and a `.PARAMETER` keyword, the description +associated with the `.PARAMETER` keyword is used, and the `param` statement +comment is ignored. ## `.EXAMPLE` -A sample command that uses the function or script, optionally followed by sample output and a -description. Repeat this keyword for each example. +A sample command that uses the function or script, optionally followed by +sample output and a description. Repeat this keyword for each example. ## `.INPUTS` -The Microsoft .NET Framework types of objects that can be piped to the function or script. You can -also include a description of the input objects. +The .NET types of objects that can be piped to the function or script. You can +also include a description of the input objects. Repeat this keyword for each +input type. ## `.OUTPUTS` -The .NET Framework type of the objects that the cmdlet returns. You can also include a description -of the returned objects. +The .NET type of the objects that the cmdlet returns. You can also include a +description of the returned objects. Repeat this keyword for each output type. ## `.NOTES` @@ -62,84 +67,99 @@ Additional information about the function or script. ## `.LINK` -The name of a related topic. Repeat this keyword for each related topic. This content appears in the -Related Links section of the Help topic. +The name of a related topic. Repeat this keyword for each related topic. This +content appears in the Related Links section of the Help topic. -The `.LINK` keyword content can also include a Uniform Resource Identifier (URI) to an online -version of the same Help topic. The online version opens when you use the `Online` parameter of -`Get-Help`. The URI must begin with "http" or "https". +The `.LINK` keyword content can also include a Uniform Resource Identifier +(URI) to an online version of the same help topic. The online version opens +when you use the **Online** parameter of `Get-Help`. The URI must begin with +`http` or `https`. ## `.COMPONENT` -The name of the technology or feature that the function or script uses, or to which it's related. -The **Component** parameter of `Get-Help` uses this value to filter the search results returned by -`Get-Help`. +The name of the technology or feature that the function or script uses, or to +which it's related. The **Component** parameter of `Get-Help` uses this value +to filter the search results returned by `Get-Help`. ## `.ROLE` -The name of the user role for the help topic. The **Role** parameter of `Get-Help` uses this value -to filter the search results returned by `Get-Help`. +The name of the user role for the help topic. The **Role** parameter of +`Get-Help` uses this value to filter the search results returned by `Get-Help`. ## `.FUNCTIONALITY` -The keywords that describe the intended use of the function. The **Functionality** parameter of -`Get-Help` uses this value to filter the search results returned by `Get-Help`. +The keywords that describe the intended use of the function. The +**Functionality** parameter of `Get-Help` uses this value to filter the search +results returned by `Get-Help`. ## `.FORWARDHELPTARGETNAME ` -Redirects to the Help topic for the specified command. You can redirect users to any Help topic, -including Help topics for a function, script, cmdlet, or provider. +Redirects to the help topic for the specified command. You can redirect users +to any help topic, including help content for a function, script, cmdlet, or +provider. -## `.FORWARDHELPCATEGORY ` +```powershell +# .FORWARDHELPTARGETNAME +``` -Specifies the Help category of the item in `.FORWARDHELPTARGETNAME`. Use this keyword to avoid -conflicts when there are commands with the same name. +## `.FORWARDHELPCATEGORY` -Valid values are: +Specifies the help category of the item in `.FORWARDHELPTARGETNAME`. Valid +values are `Alias`, `Cmdlet`, `HelpFile`, `Function`, `Provider`, `General`, +`FAQ`, `Glossary`, `ScriptCommand`, `ExternalScript`, `Filter`, or `All`. Use +this keyword to avoid conflicts when there are commands with the same name. -- Alias -- Cmdlet -- HelpFile -- Function -- Provider -- General -- FAQ -- Glossary -- ScriptCommand -- ExternalScript -- Filter -- All +```powershell +# .FORWARDHELPCATEGORY +``` ## `.REMOTEHELPRUNSPACE ` -Specifies a session that contains the Help topic. Enter a variable that contains a PSSession. This -keyword is used by the `Export-PSSession` cmdlet to find the Help topics for the exported commands. +Specifies a session that contains the help topic. Enter a variable that +contains a **PSSession** object. This keyword is used by the +[Export-PSSession][09] cmdlet to find the help content for the exported +commands. + +```powershell +# .REMOTEHELPRUNSPACE +``` + +## `.EXTERNALHELP` + +Specifies an XML-based help file for the script or function. -## `.EXTERNALHELP ` +```powershell +# .EXTERNALHELP +``` -Specifies the path and/or name of an XML-based Help file for the script or function. +The `.EXTERNALHELP` keyword is required when a function or script is documented +in XML files. Without this keyword, `Get-Help` can't find the XML-based help +file for the function or script. -The `.EXTERNALHELP` keyword tells the [Get-Help][02] cmdlet to get help for the script or function -in an XML-based file. The `.EXTERNALHELP` keyword is required when using an XML-based help file for -a script or function. Without it, `Get-Help` will not find a help file for the function or script. +The `.EXTERNALHELP` keyword takes precedence over other comment-based help +keywords. If `.EXTERNALHELP` is present, `Get-Help` doesn't display +comment-based help, even if it can't find a help topic that matches the value +of the `.EXTERNALHELP` keyword. -The `.EXTERNALHELP` keyword takes precedence over all other comment-based help keywords. When -`.EXTERNALHELP` is present, the [Get-Help][02] cmdlet doesn't display comment-based help, even when -it can't find a help file that matches the value of the keyword. +If the function is exported by a module, set the value of the `.EXTERNALHELP` +keyword to a filename without a path. `Get-Help` looks for the specified file +name in a language-specific subdirectory of the module directory. There are no +requirements for the name of the XML-based help file for a function, but a best +practice is to use the following format: -When the function is exported by a script module, the value of `.EXTERNALHELP` should be a filename -without a path. `Get-Help` looks for the file in a locale-specific subdirectory of the module -directory. There are no requirements for the filename, but a best practice is to use the following -filename format: `.psm1-help.xml`. +```Syntax +-help.xml +``` -When the function isn't associated with a module, include a path and filename in the value of the -`.EXTERNALHELP` keyword. If the specified path to the XML file contains UI-culture-specific -subdirectories, `Get-Help` searches the subdirectories recursively for an XML file with the name of -the script or function in accordance with the language fallback standards established for Windows, -just as it does for all XML-based Help topics. +If the function isn't included in a module, include a path to the XML-based +help file. If the value includes a path and the path contains +UI-culture-specific subdirectories, `Get-Help` searches the subdirectories +recursively for an XML file with the name of the script or function in +accordance with the language fallback standards established for Windows, just +as it does in a module directory. -For more information about the cmdlet Help XML-based Help file format, see -[Writing Windows PowerShell Cmdlet Help][01]. +For more information about the cmdlet help XML-based help file format, see +[How to Write Cmdlet Help][01]. [01]: ./writing-help-for-windows-powershell-cmdlets.md