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

Edit for clarity #11261

Merged
merged 4 commits into from
Jul 18, 2024
Merged

Edit for clarity #11261

merged 4 commits into from
Jul 18, 2024

Conversation

guillermooo
Copy link
Contributor

@guillermooo guillermooo commented Jul 12, 2024

PR Summary

Reword to improve clarity. Emphasize that changes to preference variables are not global by default.

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.

Copy link
Contributor

Learn Build status updates of commit 42bb0df:

✅ Validation status: passed

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

For more details, please refer to the build report.

For any questions, please:

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).

@smhwangd73 smhwangd73 mentioned this pull request Jul 13, 2024
@michaeltlombardi
Copy link
Contributor

@guillermooo - Thank you so much for this and your other recent submissions!

To make reviewing and merging easier, can you combine the changes from #11262 and #11263 into this PR? It would also help if you can pull the changes across every version of the file in the documentation. We have some automation that makes checking whether you've updated all the versioned documentation a bit easier, documented in How to submit pull requests. For quick reference, here's the versioned change report for this PR.

When pulling changes across versions, you can use the compare files feature in VS Code, which also works in GitHub CodeSpaces.

I'm going to close the other PRs for now. Thank you!

@guillermooo
Copy link
Contributor Author

@michaeltlombardi Do you mean you'd like to see all changes in the same commit or in separate commits in the same PR?

Reword to improve clarity. Emphasize that changes to preference
variables are not global by default.
Use shorter sentences.
Copy link
Contributor

Learn Build status updates of commit afea114:

✅ Validation status: passed

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

For more details, please refer to the build report.

For any questions, please:

@guillermooo guillermooo changed the title Clarify note Edit for clarity Jul 17, 2024
@guillermooo
Copy link
Contributor Author

@microsoft-github-policy-service agree

@michaeltlombardi
Copy link
Contributor

@michaeltlombardi Do you mean you'd like to see all changes in the same commit or in separate commits in the same PR?

I personally prefer separate commits, but we squash-merge to main, so they all become a single commit in the repository. I find it easier to review separate commits most of the time, but we don't have a requirement to use atomic commits or anything. Thank you for updating the PR! I'll get it reviewed ASAP.

Copy link
Contributor

@michaeltlombardi michaeltlombardi left a comment

Choose a reason for hiding this comment

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

The existing changes look good - I agree with your assessment of the wording for "automatic confirmation" - happy to merge when that language is updated.

Copy link
Contributor

Learn Build status updates of commit 4b0e784:

✅ Validation status: passed

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

For more details, please refer to the build report.

For any questions, please:

@michaeltlombardi michaeltlombardi merged commit ebfeacb into MicrosoftDocs:main Jul 18, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants