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.

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

Jump to bottom

(UUF) Address feedback on about_* topics #11173

Merged
merged 3 commits into from
Jun 10, 2024
Merged

(UUF) Address feedback on about_* topics #11173

merged 3 commits into from
Jun 10, 2024

Conversation

michaeltlombardi
Copy link
Contributor

PR Summary

Addresses unified user feedback for several about topics by:

  • Fixing an example in about_Function_Provider.
  • Adding a short example of invoking a newly created function in about_Functions.
  • Adding a practical example of using a for loop in about_For.

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.

@michaeltlombardi michaeltlombardi changed the title Uuf/main/about topics (UUF) Address feedback on about_* topics Jun 10, 2024
@learn-build-service-prod Learn Build Service (PROD)
Copy link
Contributor

Learn Build status updates of commit 1b7c77f:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-7.2)
reference/7.4/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-7.4)
reference/7.5/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

For any questions, please:

@michaeltlombardi
(AB#262055) Fix example in about_Function_Provider
a48223b 
This change:

- Addresses an invalid example in the `about_Function_Provider` topic,
  removing an extraneous colon (`:`).
- Fixes AB#262055
@michaeltlombardi
(AB#262067) Add example of invoking function to about_Functions
dc043de 
This change:

- Adds a short example of invoking a newly-defined function to the
  `about_Functions` topic.
- Fixes AB#262067
@michaeltlombardi
(AB#262073) Add functional example to about_For
aa5fff7 
Prior to this change, the `about_For` topic included
syntactic examples to show and discuss how to create
and use `for` loops, but no practical examples.

This change:

- Renames the existing section from `Examples` to
  `Syntax examples` to accurately describe its content.
- Adds a new `Functional example` section with a longer
  practical example that shows using `for` loops to find,
  rename, and compare files in a folder.
- Fixes AB#262073
@learn-build-service-prod Learn Build Service (PROD)
Copy link
Contributor

Learn Build status updates of commit aa5fff7:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-7.2)
reference/7.4/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-7.4)
reference/7.5/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Function_Provider.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Functions.md ✅Succeeded View (powershell-7.5)

For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit 9672a80 into MicrosoftDocs:main Jun 10, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdwheeler sdwheeler Awaiting requested review from sdwheeler sdwheeler is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@michaeltlombardi @sdwheeler