Skip to content

Commit 451e763

Browse files
authored
Clarify guidelines on plural parameter names (#28605)
1 parent 657efbb commit 451e763

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

documentation/development-docs/design-guidelines/parameter-best-practices.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ From the [_Strongly Encouraged Development Guidelines_](https://learn.microsoft.
6060
>
6161
> _Plural parameter names should be used only in those cases where the value of the parameter is always a multiple-element value. In these cases, the cmdlet should verify that multiple elements are supplied, and the cmdlet should display a warning to the user if multiple elements are not supplied._
6262
63+
A common exception to this guideline is with units, e.g. `-IntervalInSeconds`, `-MaxSizeInMegabytes`.
64+
6365
#### Parameter Alias
6466

6567
If you there is a separate nomenclature for the parameter name, or if you would like to shorten the name of the parameter so it's easier to remember, you can add an alias attribute to your parameter to allow for this functionality.

0 commit comments

Comments
 (0)