Skip to content
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

feat: fix spelling in dev comments in core/lib/zksync_core - continued #685

Merged
merged 4 commits into from
Jan 6, 2024

Conversation

dutterbutter
Copy link
Contributor

@dutterbutter dutterbutter commented Dec 14, 2023

Series of PRs: This is a part in a series of PRs aimed at enhancing spelling accuracy in this repository. See:

Once merged, a final PR will enable the dev_comments: true in the cargo-spellcheck config file.

What ❔

    • Spelling Corrections: This PR focuses on rectifying spelling errors found in the developer comments within core libraries: core/lib/zksync_core
  • Updates dictionary

Why ❔

  • Consistency and Readability: The addressed directories contain numerous spelling inaccuracies. Correcting these enhances the readability and consistency of our documentation, ensuring clear understanding for current and future developer

Checklist

  • 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.
  • Code has been formatted via zk fmt and zk lint.
  • Spellcheck has been run via cargo spellcheck --cfg=./spellcheck/era.cfg --code 1.

Deniallugo
Deniallugo previously approved these changes Dec 14, 2023
@dutterbutter dutterbutter force-pushed the db/fix-dev-comments-spell-checker-part-6 branch from d2b2dac to 48503b5 Compare January 3, 2024 14:12
github-merge-queue bot pushed a commit that referenced this pull request Jan 5, 2024
…682)

**Series of PRs: This is a part in a series of PRs aimed at enhancing
spelling accuracy in this repository. See:**

- [ ] #681
- [ ] #683
- [ ] #684
- [ ] #685

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) -->
- **Spelling Corrections in `core/lib/multivm`:** This PR focuses on
rectifying spelling errors in the developer comments within the
`core/lib/multivm` directory.
- 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. -->
- **Enhancing Code Quality:** The `core/lib/multivm` directory currently
has several spelling mistakes in the developer comments. Correcting
these errors will enhance the readability and overall quality of our
code documentation.

## 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: Fedor Sakharov <[email protected]>
@dutterbutter dutterbutter force-pushed the db/fix-dev-comments-spell-checker-part-6 branch from 48503b5 to 9fb9809 Compare January 5, 2024 23:11
github-merge-queue bot pushed a commit that referenced this pull request Jan 5, 2024
**Series of PRs: This is a part in a series of PRs aimed at enhancing
spelling accuracy in this repository. See:**

- [ ] #681
- [ ] #682
- [ ] #683
- [ ] #685

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) -->
- **Spelling Corrections**: This PR focuses on rectifying spelling
errors found in the developer comments within multiple core libraries:
`core/lib/types/`, `core/lib/eth_client/`, ` core/lib/eth_signer` ,
`core/lib/mempool`, `core/lib/merkle_tree`, `core/lib/state`
- 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. -->
- **Consistency and Readability:** The addressed directories contain
numerous spelling inaccuracies. Correcting these enhances the
readability and consistency of our documentation, ensuring clear
understanding for current and future developer

## 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: Fedor Sakharov <[email protected]>
@montekki montekki added this pull request to the merge queue Jan 6, 2024
Merged via the queue into main with commit 70c3feb Jan 6, 2024
25 checks passed
@montekki montekki deleted the db/fix-dev-comments-spell-checker-part-6 branch January 6, 2024 08:06
github-merge-queue bot pushed a commit that referenced this pull request Jan 6, 2024
**Series of PRs: This is a part in a series of PRs aimed at enhancing
spelling accuracy in this repository. See:**

- [ ] #681
- [ ] #682
- [ ] #684
- [ ] #685

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) -->
- **Spelling Corrections**: This PR focuses on rectifying spelling
errors found in the developer comments within multiple core libraries:
`core/lib/basic_types/`, `core/lib/config/src/configs/`,
`core/lib/constants/`, `core/lib/contracts/`, and `core/lib/dal/`.
- 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. -->
- **Consistency and Readability:** The addressed directories contain
numerous spelling inaccuracies. Correcting these enhances the
readability and consistency of our documentation, ensuring clear
understanding for current and future developer

## 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: Fedor Sakharov <[email protected]>
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants