Skip to content
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.

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

(GH-10459) Reorganize grouping expression docs #10461

Conversation

michaeltlombardi
Copy link
Contributor

@michaeltlombardi michaeltlombardi commented Sep 26, 2023

PR Summary

Prior to this change, the documentation for using grouped expressions in about_Operators included two subheadings:

  1. Grouping assignment statements
  2. Piping grouped expressions

However, it also defined a third use-case for grouping, which showed how to use the grouping operator to use the output of a command in an expression. This use case was documented before the subheadings and after a sentence indicating there's ways to use the grouping operator beyond overriding operator precedence.

Further, the section for grouping assignment statements was very long compared to the other use-cases and placed in the middle, despite being less commonly used than the others.

This change:

PR Checklist

  • Descriptive Title: This PR's title is a synopsis of the changes it proposes.
  • Summary: This PR's summary describes the scope and intent of the change.
  • Contributor's Guide: I have read the contributors guide.
  • Style: This PR adheres to the style guide.

Prior to this change, the documentation for using grouped expressions
in _about_Operators_ included two subheadings:

1. Grouping assignment statements
1. Piping grouped expressions

However, it also defined a third use-case for grouping, which showed
how to use the grouping operator to use the output of a command in
an expression. This use case was documented before the subheadings and
after a sentence indicating there's ways to use the grouping operator
beyond overriding operator precedence.

Further, the section for grouping assignment statements was very long
compared to the other use-cases and placed in the middle, despite being
less commonly used than the others.

This change:

- Adds a subheading for the first use case to make it equivalent to the
  others in the information hierarchy.
- Moves the section for piping grouped expressions to before the section
  for grouping assignment statements.
- Resolves MicrosoftDocs#10459
- Fixes AB#163845
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit d59288d:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 2becb46:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/About/about_Operators.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit e9f7059 into MicrosoftDocs:main Sep 26, 2023
3 checks passed
@mklement0
Copy link
Contributor

🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants