diff --git a/reference/docs-conceptual/developer/cmdlet/activity-parameters.md b/reference/docs-conceptual/developer/cmdlet/activity-parameters.md index 2d96b7960544..adffab2a71bc 100644 --- a/reference/docs-conceptual/developer/cmdlet/activity-parameters.md +++ b/reference/docs-conceptual/developer/cmdlet/activity-parameters.md @@ -1,7 +1,8 @@ --- description: Activity Parameters -ms.date: 09/13/2016 +ms.date: 02/03/2022 ms.topic: reference +no-loc: [Append, Command, String, System.Version, Compress, Keyword, Continuous, Create, array, Drain, Erase, Include, Incremental, Insert, Interval, Notify, Object, Prompt, Quiet, Retry, Select, Strict, Truncate, Verify] title: Activity Parameters --- # Activity Parameters @@ -18,7 +19,7 @@ The following table lists the recommended names and functionality for activity p |**Compress**
Data type: Keyword|Implement this parameter so that the user can specify the algorithm to use for data compression.| |**Continuous**
Data type: SwitchParameter|Implement this parameter so that data is processed until the user terminates the cmdlet when the parameter is specified. If the parameter is not specified, the cmdlet processes a predefined amount of data and then terminates the operation.| |**Create**
Data type: SwitchParameter|Implement this parameter to indicate that a resource is created if one does not already exist when the parameter is specified.| -|**Delete**
Data type: SwitchParameter|Implement this parameter so that resources are deleted when the cmdlet has completed its operation when the parameter is specified.| +|**Create**
Data type: SwitchParameter|Implement this parameter so that resources are deleted when the cmdlet has completed its operation when the parameter is specified.| |**Drain**
Data type: SwitchParameter|Implement this parameter to indicate that outstanding work items are processed before the cmdlet processes new data when the parameter is specified. If the parameter is not specified, the work items are processed immediately.| |**Erase**
Data type: Int32|Implement this parameter so that the user can specify the number of times a resource is erased before it is deleted.| |**ErrorLevel**
Data type: Int32|Implement this parameter so that the user can specify the level of errors to report.| 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 5ef3e077709a..f95358c7ae80 100644 --- a/reference/docs-conceptual/developer/help/comment-based-help-keywords.md +++ b/reference/docs-conceptual/developer/help/comment-based-help-keywords.md @@ -1,7 +1,8 @@ --- description: Comment-Based Help Keywords -ms.date: 06/09/2020 +ms.date: 02/03/2022 ms.topic: reference +no-loc: [FAQ, Function, General, Glossary, Provider, Component, Functionality, Role] title: Comment-Based Help Keywords --- # Comment-Based Help Keywords @@ -16,19 +17,18 @@ order in the comment-based Help, and they are not case-sensitive. Note that the `.EXTERNALHELP` keyword takes precedence over all other comment-based help keywords. When `.EXTERNALHELP` is present, the -[Microsoft.PowerShell.Commands.GetHelpCommand](/dotnet/api/Microsoft.PowerShell.Commands.gethelpcommand) -cmdlet does not display comment-based help, even when it cannot find a help file that matches the -value of the keyword. +[Get-Help](/powershell/module/Microsoft.PowerShell.Core/Get-Help) cmdlet does not display +comment-based help, even when it cannot find a help file that matches the value of the keyword. -## .SYNOPSIS +## `.SYNOPSIS` A brief description of the function or script. This keyword can be used only once in each topic. -## .DESCRIPTION +## `.DESCRIPTION` A detailed description of the function or script. This keyword can be used only once in each topic. -## .PARAMETER \ +## `.PARAMETER ` The description of a parameter. You can include a `.PARAMETER` keyword for each parameter in the function or script. @@ -43,26 +43,26 @@ immediately before the parameter variable name. If you use both a `Param` statem `.PARAMETER` keyword, the description associated with the `.PARAMETER` keyword is used, and the `Param` statement comment is ignored. -## .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 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. -## .OUTPUTS +## `.OUTPUTS` The .NET Framework type of the objects that the cmdlet returns. You can also include a description of the returned objects. -## .NOTES +## `.NOTES` Additional information about the function or script. -## .LINK +## `.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. @@ -71,28 +71,28 @@ The `.LINK` keyword content can also include a Uniform Resource Identifier (URI) 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 +## `.COMPONENT` The name of the technology or feature that the function or script uses, or to which it is 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 topics for a function, script, cmdlet, or provider. -## .FORWARDHELPCATEGORY \ +## `.FORWARDHELPCATEGORY ` Specifies the Help category of the item in `.FORWARDHELPTARGETNAME`. Use this keyword to avoid conflicts when there are commands with the same name. @@ -112,24 +112,23 @@ Valid values are: - Filter - All -## .REMOTEHELPRUNSPACE \ +## `.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. -## .EXTERNALHELP \ +## `.EXTERNALHELP ` Specifies the path and/or name of an XML-based Help file for the script or function. The `.EXTERNALHELP` keyword tells the -[Microsoft.PowerShell.Commands.GetHelpCommand](/dotnet/api/Microsoft.PowerShell.Commands.gethelpcommand) -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. +[Get-Help](/powershell/module/Microsoft.PowerShell.Core/Get-Help) 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 all other comment-based help keywords. When -`.EXTERNALHELP` is present, the -[Microsoft.PowerShell.Commands.GetHelpCommand](/dotnet/api/Microsoft.PowerShell.Commands.gethelpcommand) +`.EXTERNALHELP` is present, the [Get-Help](/powershell/module/Microsoft.PowerShell.Core/Get-Help) cmdlet does not display comment-based help, even when it cannot find a help file that matches the value of the keyword.