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

Markdown Fixes to 7.5 #11512

Merged
merged 3 commits into from
Nov 5, 2024
Merged

Markdown Fixes to 7.5 #11512

merged 3 commits into from
Nov 5, 2024

Conversation

ArieHein
Copy link
Contributor

@ArieHein ArieHein commented Nov 5, 2024

PR Summary

Fixing markdown warnings to align with the markdown rules per https://github.com/MicrosoftDocs/PowerShell-Docs/blob/main/.markdownlint.yaml

Specifically:
MD022 (with exception to SYNOPSIS) saved you about 300 changes, thanks for the heads up @sdwheeler !
MD012

One exception is in the PSReadLine lines 51-52 that triggered MD024 as its a duplicate of lines 42-43

Next batch containing some other MD rules for 7.5 and content coming up as well this week.

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

This comment was marked as outdated.

Copy link

github-actions bot commented Nov 5, 2024

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

@ArieHein
Copy link
Contributor Author

ArieHein commented Nov 5, 2024

Also @sdwheeler - any preferences on fixing things like for example about_ANSI_terminals.md in lines 223 that triggers a spelling error as it has "pwsh -noprofile -command 'Get-ChildIitem' > out.txt" when it should be 'Get-ChildItem'
So making sure the casing is correct in all code examples ? There are quite a few of them all over that just cause my old style PS OCD to kick in :)

Also, are you accepting adding more words to the spelling dictionaries ?

@sdwheeler
Copy link
Contributor

@ArieHein For bulk PRs like this I would like to see them focused on a single class of changes. That makes the reviews easier since all the changes should be the same.

Spelling fixes and Pascal-case code fixes can be in one class together. But be careful about the code changes. In some (rare) cases, the point of the code sample is to demonstrate a misspelling or case-insensitivity example. Make sure the change makes sense in context.

@sdwheeler
Copy link
Contributor

@ArieHein check your Discord account.

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.

See my suggestions.

reference/7.5/Microsoft.PowerShell.Core/Get-Module.md Outdated Show resolved Hide resolved
reference/7.5/PSReadLine/PSReadLine.md Outdated Show resolved Hide resolved
Copy link
Contributor

Learn Build status updates of commit 1652c9b:

✅ Validation status: passed

File Status Preview URL Details
reference/7.5/CimCmdlets/CimCmdlets.md ✅Succeeded View (powershell-7.5)
reference/7.5/CimCmdlets/Get-CimSession.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Archive/Microsoft.PowerShell.Archive.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_ANSI_Terminals.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Arithmetic_Operators.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Arrays.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Assignment_Operators.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Booleans.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Break.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Case-Sensitivity.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Character_Encoding.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_CimSession.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Classes.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Command_Syntax.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Comment_Based_Help.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Core_Commands.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Data_Files.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Data_Sections.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Do.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Environment_Provider.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Environment_Variables.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_For.md ✅Succeeded View (powershell-7.5)
reference/7.5/Microsoft.PowerShell.Core/About/about_Foreach.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_Advanced.md ✅Succeeded View (powershell-7.5)

This comment lists only the first 25 files in the pull request.
For more details, please refer to the build report.

For any questions, please:

@sdwheeler sdwheeler merged commit f89fd0a into MicrosoftDocs:main Nov 5, 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