Skip to content

Can we hide obsolete or internal-use-only helper parameters from syntax diagrams? #7868

@mklement0

Description

@mklement0

Format-Hex's -Raw switch is obsolete in PowerShell Core - it has no effect whatsoever and is only retained for backward compatibility with Windows PowerShell v5.1 (backstory here).

(As an aside: This fact is not documented, nor was the parameter's (fairly obscure) original purpose ever documented for v5.1.)

Explaining the obsolescence in the documentation will go a long way, but I wonder if there is/should be a mechanism to hide a parameter from the syntax diagram, so that its continued, pointless presence doesn't cause confusion / isn't a distraction when you run Format-Hex -? or Get-Command Format-Hex -Syntax, for instance.

The ability to hide parameters would in general also be useful for helper parameters that are solely meant to be used by a given cmdlet itself in recursive invocations, for instance.

Environment data

Written as of:

PowerShell Core 6.1.0

Metadata

Metadata

Assignees

Labels

Resolution-No ActivityIssue has had no activity for 6 months or moreWG-Cmdlets-Utilitycmdlets in the Microsoft.PowerShell.Utility module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions