about_Functions_Advanced_Parameters
is missing some useful attributes
#10136
Labels
area-about
Area - About_ topics
area-core
Area - Microsoft.PowerShell.Core module
issue-doc-bug
Issue - error in documentation
Prerequisites
Get-Foo
cmdlet" instead of "Typo."Links
Summary
The
about_Functions_Advanced_Parameters
article includes documentation for several useful attributes you can use on parameters in PowerShell. It either documents them directly or gives an overview and links to further documentation for them.However, the following useful attributes aren't mentioned:
Details
The PSDefaultValue attribute is partially documented in
about_Functions
at the end of the Named Parameters section and more documented in 12.3.8 The PSDefaultValue attribute of the language specification. Neither is very discoverable.The Credential attribute is documented in the Credential Attribute Declaration article in the SDK docs. Unfortunately, this isn't very discoverable.
The Experimental attribute is documented in about_Experimental_Features.
The PSTypeName attribute isn't mentioned in the documentation, but it's useful for script and module authors when working with custom objects and decorated types.
The System.Obsolete attribute isn't mentioned in the documentation, but it's useful for script and module authors to mark a parameter as obsolete before removing it.
Suggested Fix
Update
about_Functions_Advanced_Parameters
to document these attributes and include examples of their usage.The text was updated successfully, but these errors were encountered: