chore: error on cspell issues in docs #3886
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
5 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Dec 20, 2023
# Description ## Problem\* Resolves <!-- Link to GitHub Issue --> ## Summary\* I heard there's airdrops for typo fixes now so I've addressed all of the typos in the docs. On an unrelated note this will prevent #3886 from causing issues from existing spelling errors. ## Additional Context ## Documentation\* Check one: - [ ] No documentation needed. - [x] Documentation included in this PR. - [ ] **[Exceptional Case]** Documentation to be submitted in a separate PR. # PR Checklist\* - [x] I have tested the changes locally. - [x] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings.
kevaundray
approved these changes
Dec 20, 2023
TomAFrench
added a commit
that referenced
this pull request
Dec 28, 2023
* master: chore: Optimize goto_definitions for workspace case (#3914) chore: Update index.md (#3911) chore: Update index.md (#3910) chore: Update how-to-recursion.md (#3912) feat: Resolve oracle calls via JSON-RPC (#3902) chore: Update explainer-recursion.md (#3906) chore: remove unnecessary dependency (#3901) chore: improve package.json metadata (#3900) feat: prefer `AcirContext`-native methods for performing logic operations (#3898) feat: optimize logic gate ACIR-gen (#3897) fix: allow abi encoding tuples from JS (#3894) chore: error on cspell issues in docs (#3886)
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.
Description
Problem*
Resolves
Summary*
This PR updates the spellcheck workflow to run a separate pass over the docs which will error rather than raising a warning. This is as it's more important to catch spelling issues in the docs rather than in the code (plus the docs is going to use fewer non-standard-english library names, etc. so false positives will be rarer.
Additional Context
Documentation*
Check one:
PR Checklist*
cargo fmton default settings.