Skip to content

Fixes #11606 - More feedback on numeric parameters #11632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 4, 2025
Merged

Fixes #11606 - More feedback on numeric parameters #11632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions ...ence/5.1/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Explains how to add parameters to advanced functions.
Locale: en-US
ms.date: 01/02/2025
ms.date: 01/04/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_Advanced_Parameters
Expand Down Expand Up @@ -40,9 +40,9 @@ decimal digits, alphabetic characters, and underscores. For a complete list of
naming rules, see [about_Variables][20].

> [!IMPORTANT]
> It's possible to name a parameter using only decimal digits. Using numeric
> parameter names isn't recommended because it can lead to confusion with
> positional parameters.
> It's possible to define a parameter that starts with a decimal digit.
> Starting parameter names with a digit isn't recommended because PowerShell
> treats them as string values passed as positional parameters.

Consider the following example:

Expand All @@ -58,8 +58,8 @@ function TestFunction {
}
```

If you try to use the parameters, PowerShell interprets them as negative
numbers passed as positional parameter.
If you try to use the parameters, PowerShell interprets them as stings passed
as positional parameter.

```powershell
PS> TestFunction -100 -200 Hello
Expand Down
12 changes: 6 additions & 6 deletions ...ence/7.4/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Explains how to add parameters to advanced functions.
Locale: en-US
ms.date: 01/02/2025
ms.date: 01/04/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_Advanced_Parameters
Expand Down Expand Up @@ -40,9 +40,9 @@ decimal digits, alphabetic characters, and underscores. For a complete list of
naming rules, see [about_Variables][20].

> [!IMPORTANT]
> It's possible to name a parameter using only decimal digits. Using numeric
> parameter names isn't recommended because it can lead to confusion with
> positional parameters.
> It's possible to define a parameter that starts with a decimal digit.
> Starting parameter names with a digit isn't recommended because PowerShell
> treats them as string values passed as positional parameters.

Consider the following example:

Expand All @@ -58,8 +58,8 @@ function TestFunction {
}
```

If you try to use the parameters, PowerShell interprets them as negative
numbers passed as positional parameter.
If you try to use the parameters, PowerShell interprets them as stings passed
as positional parameter.

```powershell
PS> TestFunction -100 -200 Hello
Expand Down
12 changes: 6 additions & 6 deletions ...ence/7.5/Microsoft.PowerShell.Core/About/about_Functions_Advanced_Parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
description: Explains how to add parameters to advanced functions.
Locale: en-US
ms.date: 01/02/2025
ms.date: 01/04/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_functions_advanced_parameters?view=powershell-7.5&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_Functions_Advanced_Parameters
Expand Down Expand Up @@ -40,9 +40,9 @@ decimal digits, alphabetic characters, and underscores. For a complete list of
naming rules, see [about_Variables][20].

> [!IMPORTANT]
> It's possible to name a parameter using only decimal digits. Using numeric
> parameter names isn't recommended because it can lead to confusion with
> positional parameters.
> It's possible to define a parameter that starts with a decimal digit.
> Starting parameter names with a digit isn't recommended because PowerShell
> treats them as string values passed as positional parameters.

Consider the following example:

Expand All @@ -58,8 +58,8 @@ function TestFunction {
}
```

If you try to use the parameters, PowerShell interprets them as negative
numbers passed as positional parameter.
If you try to use the parameters, PowerShell interprets them as stings passed
as positional parameter.

```powershell
PS> TestFunction -100 -200 Hello
Expand Down