feat: address remaining spelling issues in dev comments and turns on dev_comments in cfg #827
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
…nts in the spellcheck cfg
dutterbutter
changed the title
dutterbutter
changed the title
montekki
reviewed
Jan 7, 2024
montekki
approved these changes
Jan 7, 2024
This was referenced Jan 7, 2024
10 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 9, 2024
…late (#681) **Series of PRs: This is the first in a series PRs aimed at enhancing spelling accuracy in this repository.** See: - [ ] #682 - [ ] #683 - [ ] #684 - [ ] #685 - [ ] #827 Once merged, a final PR will enable the `dev_comments: true` in the cargo-spellcheck config file. ## What ❔ <!-- What are the changes this PR brings about? --> <!-- Example: This PR adds a PR template to the repo. --> <!-- (For bigger PRs adding more context is appreciated) --> - **Introduction of cspell checker:** This PR integrates the cspell checker into the CI, specifically targeting the `/docs` directory to identify and correct spelling errors. - Updates PR template to include `cspell` command - Updates dictionary ## Why ❔ <!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> <!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> - **Improving Documentation Quality:** The `/docs` directory currently contains numerous spelling errors. By resolving these and integrating a spellcheck step in our CI, we aim to maintain high-quality, error-free documentation. - **Preventing Future Spelling Mistakes:** The cspell checker will help in automatically detecting and preventing spelling errors in future contributions. ## Checklist <!-- Check your PR fulfills the following items. --> <!-- For draft PRs check the boxes as you complete them. --> - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [ ] Documentation comments have been added / updated. - [x] Code has been formatted via `zk fmt` and `zk lint`. - [x] Spellcheck has been run via `cargo spellcheck --cfg=./spellcheck/era.cfg --code 1`. --------- Co-authored-by: Oleksandr Stepanov <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jan 11, 2024
🤖 I have created a release *beep* *boop* --- ## [19.1.0](core-v19.0.0...core-v19.1.0) (2024-01-10) ### Features * address remaining spelling issues in dev comments and turns on dev_comments in cfg ([#827](#827)) ([1fd0afd](1fd0afd)) * **core:** removes multiple tokio runtimes and worker number setting. ([#826](#826)) ([b8b190f](b8b190f)) * fix spelling in dev comments in `core/lib/*` - continued ([#683](#683)) ([0421fe6](0421fe6)) * fix spelling in dev comments in `core/lib/*` - continued ([#684](#684)) ([b46c2e9](b46c2e9)) * fix spelling in dev comments in `core/lib/multivm` - continued ([#682](#682)) ([3839d39](3839d39)) * fix spelling in dev comments in `core/lib/zksync_core` - continued ([#685](#685)) ([70c3feb](70c3feb)) * **state-keeper:** circuits seal criterion ([#729](#729)) ([c4a86bb](c4a86bb)) * **state-keeper:** Reject transactions that fail to publish bytecodes ([#832](#832)) ([0a010f0](0a010f0)) * **vm:** Add batch input abstraction ([#817](#817)) ([997db87](997db87)) ### Bug Fixes * oldest unpicked batch ([#692](#692)) ([a6c869d](a6c869d)) * **state-keeper:** Updates manager keeps track of fictive block metrics ([#843](#843)) ([88fd724](88fd724)) * **vm:** fix circuit tracer ([#837](#837)) ([83fc7be](83fc7be)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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.
Related to: #681
What ❔
Why ❔
Checklist
zk fmtandzk lint.cargo spellcheck --cfg=./spellcheck/era.cfg --code 1.