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

fix: Documentation Corrections and Clarifications #1962

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

savvar9991
Copy link
Contributor

1. First change (line 6 in the first file):

There are 6 precompiles implemented in REVM → There are 7 precompiles implemented in REVM

The number of precompiles was corrected from 6 to 7, which is a factual correction as the list indeed contains 7 precompiles.

2. In the kzg.md file, the following changes were made:

a much more bigger scale → a much bigger scale

Justification: Fixed a grammatical error in the comparative form of the adjective. In English, you cannot use both "more" and the "-er" suffix simultaneously to form a comparative degree. It's correct to use either "more big" or "bigger", but not both. In this case, "a much bigger scale" is the correct form.

3. Changes in builder.md (lines 8 and 12):

It allows handle registers → It allows handler registers

Fixed a typo: "handle" was replaced with "handler", which is the correct technical term in this context.

4. Article Addition (line 31):

Functions from one stage are just renamed functions from other stage, it is made so that user is more aware of what underlying function does.
→ Functions from one stage are just renamed functions from other stage, it is made so that the user is more aware of what underlying function does.

Justification: Added the definite article "the" before "user". This is a grammatical improvement as when referring to a specific type of person (in this case, a user of the system), the definite article is required in English.

5. Handler Modification Change (line 160):

They are used to add custom logic to the evm execution but as they are free to modify the Handler in any form they want.
→ They are used to add custom logic to the evm execution but they are free to modify the Handler in any form they want.

Justification: Removed the word "as" which was creating a redundant clause structure. The new version is more concise and clearer, while maintaining the same meaning.

Copy link

codspeed-hq bot commented Jan 1, 2025

CodSpeed Performance Report

Merging #1962 will improve performances by 3.14%

Comparing savvar9991:fix-bug/error (4dfd39d) with main (6f3d9f8)

Summary

⚡ 1 improvements
✅ 7 untouched benchmarks

Benchmarks breakdown

Benchmark main savvar9991:fix-bug/error Change
`precompile bench ecrecover precompile` 202.3 µs 196.1 µs

Copy link
Member

@rakita rakita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@rakita rakita merged commit 223a2d6 into bluealloy:main Jan 3, 2025
28 checks passed
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.

2 participants