Ignore triple-backtick code blocks in spellcheck #919
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change teaches our spellcheck plugin to ignore triple-backtick style code blocks. Without this, spellcheck is trying to process the code samples in markdown as if they were not code. This is a port of the fix already applied to radius-project/design-notes. The typo in the branch name was not intentional, and adds an extra layer of irony to this change. Signed-off-by: Ryan Nowak <[email protected]>
AaronCrawfis
approved these changes
Oct 31, 2023
jasonviviano
pushed a commit
that referenced
this pull request
Nov 6, 2023
This change teaches our spellcheck plugin to ignore triple-backtick style code blocks. Without this, spellcheck is trying to process the code samples in markdown as if they were not code. This is a port of the fix already applied to radius-project/design-notes. The typo in the branch name was not intentional, and adds an extra layer of irony to this change. Signed-off-by: Ryan Nowak <[email protected]> Signed-off-by: jasonviviano <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thank you for helping make the Radius documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
This change teaches our spellcheck plugin to ignore triple-backtick style code blocks. Without this, spellcheck is trying to process the code samples in markdown as if they were not code.
This is a port of the fix already applied to radius-project/design-notes.
The typo in the branch name was not intentional, and adds an extra layer of irony to this change.
Auto-generated description
🤖 Generated by Copilot at 09da2ba
Summary
🌟📝🎨
Enable syntax highlighting for code blocks in documentation. Update
.pyspelling.ymlto usefenced_codeextension for markdown parsing.Walkthrough
Issue reference