From d512d1e3ac38ca47634bc789445be53a76afc249 Mon Sep 17 00:00:00 2001 From: Yeming Liu <11371776+isra-fel@users.noreply.github.com> Date: Tue, 23 Sep 2025 16:53:34 +1000 Subject: [PATCH] Clarify guidelines on plural parameter names Added exception for plural parameter names regarding units. --- .../design-guidelines/parameter-best-practices.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/development-docs/design-guidelines/parameter-best-practices.md b/documentation/development-docs/design-guidelines/parameter-best-practices.md index c12ff59809f8..d389ff48f856 100644 --- a/documentation/development-docs/design-guidelines/parameter-best-practices.md +++ b/documentation/development-docs/design-guidelines/parameter-best-practices.md @@ -60,6 +60,8 @@ From the [_Strongly Encouraged Development Guidelines_](https://learn.microsoft. > > _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._ +A common exception to this guideline is with units, e.g. `-IntervalInSeconds`, `-MaxSizeInMegabytes`. + #### Parameter Alias 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.