-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Markdown Fixes to 7.5 #11512
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
ExpectationsThanks 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:
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). |
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' Also, are you accepting adding more words to the spelling dictionaries ? |
@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. |
@ArieHein check your Discord account. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See my suggestions.
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.