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

Quality: Cleanup of Start, Stop and Wait-Job examples #10474

Merged
merged 2 commits into from
Sep 29, 2023

Conversation

ehmiiz
Copy link
Contributor

@ehmiiz ehmiiz commented Sep 29, 2023

PR Summary

Prior to this PR, the Get-Help for the cmdlets Start-Job, Stop-Job and Wait-Job had some minor code samples formatting issues including missing parameter names and usage of alias.

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.

@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit d6d1aeb:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

@github-actions
Copy link

Expectations

Thanks for your submission! Here's a quick note to provide you with some context for what to expect from the docs team and the process now that you've submitted a PR. Even if you've contributed to this repo before, we strongly suggest reading this information; it might have changed since you last read it.

To see our process for reviewing PRs, please read our editor's checklist and process for managing pull requests in particular. Below is a brief, high-level summary of what to expect, but our contributor guide has expanded details.

The docs team begins to review your PR if you request them to or if your PR meets these conditions:

  • It is not a draft PR.
  • It does not have a WIP prefix in the title.
  • It passes validation and build steps.
  • It does not have any merge conflicts.
  • You have checked every box in the PR Checklist, indicating you have completed all required steps and marked your PR as Ready to Merge.

You can always request a review at any stage in your authoring process, the docs team is here to help! You do not need to submit a fully polished and finished draft; the docs team can help you get content ready for merge.

While reviewing your PR, the docs team may make suggestions, write comments, and ask questions. When all requirements are satisfied, the docs team marks your PR as Approved and merges it. Once your PR is merged, it is included the next time the documentation is published. For this project, the documentation is published daily at 3 p.m. Pacific Standard Time (PST).

@sdwheeler sdwheeler added the project-quality Project - used to label items that are part of the Quality project label Sep 29, 2023
@learn-build-service-prod
Copy link
Contributor

Learn Build status updates of commit 2d99107:

✅ Validation status: passed

File Status Preview URL Details
reference/5.1/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-5.1)
reference/5.1/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-5.1)
reference/7.2/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7.2)
reference/7.2/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-7.2)
reference/7.3/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7.3)
reference/7.3/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-7.3)
reference/7.4/Microsoft.PowerShell.Core/Start-Job.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/Stop-Job.md ✅Succeeded View (powershell-7.4)
reference/7.4/Microsoft.PowerShell.Core/Wait-Job.md ✅Succeeded View (powershell-7.4)

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ehmiiz Thanks again!

@sdwheeler sdwheeler merged commit dbbabb6 into MicrosoftDocs:main Sep 29, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
project-quality Project - used to label items that are part of the Quality project
Development

Successfully merging this pull request may close these issues.

Quality: Example cleanup of the *-Job cmdlet
2 participants