Skip to content

Update description of .INPUTS and .OUTPUTS keywords to state they can be repeated #12087

@RobertKlohr

Description

@RobertKlohr

Type of issue

Missing information

Feedback

I am working on testing the new PlatyPS cmdlet got feedback from that team that they .INPUTS and .OUTPUTS keywords could be repeated and should be formatted as shown below. If this is correct, then the documentation on those keywords needs to be updated on about_Comment_Based_Help and Comment-Based Help Keywords (possibly other pages that discuss comment-based help syntax and keywords) to state they can be repeated. It would also be helpful to have at least one example on Examples of Comment-based Help that shows these keywords repeated.

<#
    .INPUTS
        System.Int32

    .INPUTS
        System.Management.Automation.SwitchParameter

    .OUTPUTS
        Microsoft.PowerShell.Commands.WebResponseObject

        The function returns the results of the API request in a WebResponseObject object by default.

    .OUTPUTS
        System.Net.Http.HttpRequestException

        The function returns a HttpRequestException object if there is an error in the HTTP request. Typically thrown when an HTTP request fails due to network issues, invalid responses, or other errors related to HTTP communication.

    .OUTPUTS
        System.String

        If the function is called with -OutputTypeRaw parameter it returns the results of the API request as a JSON formatted string.

#>

Page URL

https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_comment_based_help?view=powershell-7.5

Content source URL

https://github.com/MicrosoftDocs/PowerShell-Docs/blob/main/reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md

Author

@sdwheeler

Platform Id

9f1c3f37-78ee-1b8e-2745-c7e570e13e01

Document Id

7c0a58c2-c4ca-6f7d-f6ce-0cf4df193e0a

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions