Skip to content

ValueFromRemainingArguments parameters are not reflected as such in syntax diagrams #4626

@mklement0

Description

@mklement0

Related: #4715 and #4135.

It is currently hard to discover if a given cmdlet/function has a ValueFromRemainingArguments parameter, so I suggest we add a new representation to syntax diagrams to signal that a given cmdlet / advanced supports does so.

We'll have to decide what an adequate representation is.

For instance, Write-Host -? shows the following for its ValueFromRemainingArguments -Object parameter:

[[-Object] <Object>]

which does not reflect its "specialness" - you can't tell that this parameter enables specifying multiple, independent arguments that are all bound to -Object, enabling convenient free-form invocations as Write-Host a b c in lieu of (the also supported) Write-Host -Object a, b, c

Perhaps something along the lines of (updated based on the discussion below):

[-Object <Object> | <Object> ... ]

With an array-typed parameter, such as Join-Path's -AdditionalChildPath:

[-AdditionalChildPath <string[]> | <string> ...]

Environment data

PowerShell Core v6.0.0-beta.5 on macOS 10.12.6
PowerShell Core v6.0.0-beta.5 on Ubuntu 16.04.3 LTS
PowerShell Core v6.0.0-beta.5 on Microsoft Windows 10 Pro (64-bit; v10.0.15063)
Windows PowerShell v5.1.15063.483 on Microsoft Windows 10 Pro (64-bit; v10.0.15063)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Issue-Enhancementthe issue is more of a feature request than a bugResolution-No ActivityIssue has had no activity for 6 months or moreWG-Interactive-HelpSystemhelp infrastructure and formatting of help

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions