Added pre-sorting required to groupby param. (#11583)

mikefrobbins · web-flow · commit 236615e4cbc5 · 2024-12-12T11:47:47.000-06:00
Co-authored-by: Mike F. Robbins &lt;mikefrobbins@users.noreply.github.com&gt;
diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Format-Custom.md b/reference/5.1/Microsoft.PowerShell.Utility/Format-Custom.md
@@ -161,7 +161,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Formats the output in groups based on a shared property or value. Enter an expression or a property
-of the output.
+of the output. The **GroupBy** parameter expects that the objects are sorted. Use the `Sort-Object`
+cmdlet before using `Format-Custom` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Format-List.md b/reference/5.1/Microsoft.PowerShell.Utility/Format-List.md
@@ -175,7 +175,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Specifies the output in groups based on a shared property or value. Enter an expression or a
-property of the output.
+property of the output. The **GroupBy** parameter expects that the objects are sorted. Use the
+`Sort-Object` cmdlet before using `Format-List` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
@@ -314,9 +315,6 @@ verb (the `Out` cmdlets), such as `Out-Host` or `Out-File`.
 If you do not use a format cmdlet, PowerShell applies that default format for each object that it
 displays.
 
-The **GroupBy** parameter assumes that the objects are sorted. Use `Sort-Object` before using
-`Format-List` to group the objects.
-
 The **View** parameter lets you specify an alternate format for the table. You can use the views
 defined in the `*.format.PS1XML` files in the PowerShell directory, or you can create your own views
 in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
diff --git a/reference/5.1/Microsoft.PowerShell.Utility/Format-Wide.md b/reference/5.1/Microsoft.PowerShell.Utility/Format-Wide.md
@@ -177,7 +177,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Formats the output in groups based on a shared property or value. Enter an expression or a property
-of the output.
+of the output. The **GroupBy** parameter expects that the objects are sorted. Use the `Sort-Object`
+cmdlet before using `Format-Wide` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
@@ -307,9 +308,6 @@ Windows PowerShell includes the following aliases for `Format-Wide`:
 
 - `fw`
 
-The **GroupBy** parameter assumes that the objects are sorted. Use `Sort-Object` before using
-`Format-Custom` to group the objects.
-
 The **View** parameter lets you specify an alternate format for the table. You can use the views
 defined in the `*.format.PS1XML` files in the PowerShell directory or you can create your own views
 in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Format-Custom.md b/reference/7.4/Microsoft.PowerShell.Utility/Format-Custom.md
@@ -161,7 +161,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Formats the output in groups based on a shared property or value. Enter an expression or a property
-of the output.
+of the output. The **GroupBy** parameter expects that the objects are sorted. Use the `Sort-Object`
+cmdlet before using `Format-Custom` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Format-List.md b/reference/7.4/Microsoft.PowerShell.Utility/Format-List.md
@@ -175,7 +175,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Specifies the output in groups based on a shared property or value. Enter an expression or a
-property of the output.
+property of the output. The **GroupBy** parameter expects that the objects are sorted. Use the
+`Sort-Object` cmdlet before using `Format-List` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
@@ -315,9 +316,6 @@ verb (the `Out` cmdlets), such as `Out-Host` or `Out-File`.
 If you do not use a format cmdlet, PowerShell applies that default format for each object that it
 displays.
 
-The **GroupBy** parameter assumes that the objects are sorted. Use `Sort-Object` before using
-`Format-List` to group the objects.
-
 The **View** parameter lets you specify an alternate format for the table. You can use the views
 defined in the `*.format.PS1XML` files in the PowerShell directory, or you can create your own views
 in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
diff --git a/reference/7.4/Microsoft.PowerShell.Utility/Format-Wide.md b/reference/7.4/Microsoft.PowerShell.Utility/Format-Wide.md
@@ -177,7 +177,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Formats the output in groups based on a shared property or value. Enter an expression or a property
-of the output.
+of the output. The **GroupBy** parameter expects that the objects are sorted. Use the `Sort-Object`
+cmdlet before using `Format-Wide` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
@@ -308,9 +309,6 @@ PowerShell includes the following aliases for `Format-Wide`:
 - All platforms:
   - `fw`
 
-The **GroupBy** parameter assumes that the objects are sorted. Use `Sort-Object` before using
-`Format-Custom` to group the objects.
-
 The **View** parameter lets you specify an alternate format for the table. You can use the views
 defined in the `*.format.PS1XML` files in the PowerShell directory or you can create your own views
 in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Format-Custom.md b/reference/7.5/Microsoft.PowerShell.Utility/Format-Custom.md
@@ -161,7 +161,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Formats the output in groups based on a shared property or value. Enter an expression or a property
-of the output.
+of the output. The **GroupBy** parameter expects that the objects are sorted. Use the `Sort-Object`
+cmdlet before using `Format-Custom` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Format-List.md b/reference/7.5/Microsoft.PowerShell.Utility/Format-List.md
@@ -175,7 +175,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Specifies the output in groups based on a shared property or value. Enter an expression or a
-property of the output.
+property of the output. The **GroupBy** parameter expects that the objects are sorted. Use the
+`Sort-Object` cmdlet before using `Format-List` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
@@ -315,9 +316,6 @@ verb (the `Out` cmdlets), such as `Out-Host` or `Out-File`.
 If you do not use a format cmdlet, PowerShell applies that default format for each object that it
 displays.
 
-The **GroupBy** parameter assumes that the objects are sorted. Use `Sort-Object` before using
-`Format-List` to group the objects.
-
 The **View** parameter lets you specify an alternate format for the table. You can use the views
 defined in the `*.format.PS1XML` files in the PowerShell directory, or you can create your own views
 in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
diff --git a/reference/7.5/Microsoft.PowerShell.Utility/Format-Wide.md b/reference/7.5/Microsoft.PowerShell.Utility/Format-Wide.md
@@ -177,7 +177,8 @@ Accept wildcard characters: False
 ### -GroupBy
 
 Formats the output in groups based on a shared property or value. Enter an expression or a property
-of the output.
+of the output. The **GroupBy** parameter expects that the objects are sorted. Use the `Sort-Object`
+cmdlet before using `Format-Wide` to group the objects.
 
 The value of the **GroupBy** parameter can be a new calculated property. The calculated property can
 be a script block or a hash table. Valid key-value pairs are:
@@ -308,9 +309,6 @@ PowerShell includes the following aliases for `Format-Wide`:
 - All platforms:
   - `fw`
 
-The **GroupBy** parameter assumes that the objects are sorted. Use `Sort-Object` before using
-`Format-Custom` to group the objects.
-
 The **View** parameter lets you specify an alternate format for the table. You can use the views
 defined in the `*.format.PS1XML` files in the PowerShell directory or you can create your own views
 in new PS1XML files and use the `Update-FormatData` cmdlet to include them in PowerShell.
