Repository navigation
👷 Spellcheck the docs in CI and fix the typos it found - #101
Merged
Merged
Conversation
A pre-commit cspell hook checks every Markdown and reStructuredText file, and a workflow runs it on pull requests and pushes to main. cspell.json gains the technical words and names the docs use, plus patterns that skip compiler flags and Conan cache paths.
This file contains hidden or 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
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.
Adds a spellcheck to CI and fixes the typos it found.
CI
.pre-commit-config.yamlruns the cspell hook (cspell-cliv8.6.0, as in scatter_span) on every.mdand.rstfile.pre-commit run --all-filesruns the same check.cspell.json
datasheet,baremetal,pimpl,semihosting,JTAG,NVICandMISRA;pyocd,picolibc,newlibandmkdocs;Rohde,Schwarz,EspressifandInvenSense.-Osemihost_console_type,-Dbreathe_projectsand-Tyour_linker_script.ld, and one for Conan cache paths, which contain package hashes.Typos fixed
contributor_guide/architecture.mdREADME.mdgetting_started.mdeducation/adc.mdcontributor_guide/arm/arm_cortex_m_bringup.mduser_guide/debugging.mdTesting