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.

Sign up for GitHub

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

Jump to bottom

typo: fix comments and docs into more sensible #1920

Merged
merged 6 commits into from
Dec 20, 2024
Merged

typo: fix comments and docs into more sensible #1920

merged 6 commits into from
Dec 20, 2024

Conversation

lancorer
Copy link
Contributor

@lancorer lancorer commented Dec 16, 2024 •
edited
Loading

Problem

Started from updating this line:

revm/crates/bytecode/src/eof/header.rs

Line 12 in 3774f6e

/// types section includes num of input and outputs and max stack size.

But analyzing over 4000 whole comments!

Solution

Tasks

  • Fix typo within // comments.
  • Update important notes. (l1, TODO, Note, SAFETY, Important)
  • Fix typo within /// comments.

@lancorer
Copy link
Contributor Author

lancorer commented Dec 16, 2024 •
edited
Loading

@rakita @shemnon
Can you please help why doc test is failing?

@rakita
Copy link
Member

rakita commented Dec 18, 2024

Will check it out, amazing work btw!

@lancorer lancorer force-pushed the fix-comments-typo-and-doc branch from 9021f36 to 67d68d9 Compare December 18, 2024 19:10
@lancorer
Copy link
Contributor Author

lancorer commented Dec 18, 2024 •
edited
Loading

@rakita
I've rebased to main branch and seems it's fine now.
I will head to the last task.

rakita
rakita reviewed Dec 20, 2024
View reviewed changes
crates/revm/CHANGELOG.md Outdated Show resolved Hide resolved
@rakita
Copy link
Member

rakita commented Dec 20, 2024

@lancorer what did you use to make this change?

rakita
rakita approved these changes Dec 20, 2024
View reviewed changes
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! Pending merge and reverting of few files.

@lancorer
Copy link
Contributor Author

@lancorer what did you use to make this change?

Just editor lol

@lancorer lancorer force-pushed the fix-comments-typo-and-doc branch from 67d68d9 to a388df2 Compare December 20, 2024 07:54
@rakita
Copy link
Member

rakita commented Dec 20, 2024

Just editor lol

lol, amazing!

@rakita rakita marked this pull request as ready for review December 20, 2024 08:11
@lancorer lancorer marked this pull request as draft December 20, 2024 08:21
@lancorer
Copy link
Contributor Author

@rakita
Haven't pushed last task yet and revert changes.

@lancorer lancorer marked this pull request as ready for review December 20, 2024 11:27
@lancorer lancorer force-pushed the fix-comments-typo-and-doc branch from 2b7d613 to 6129de9 Compare December 20, 2024 11:32
@rakita rakita merged commit 17c4543 into bluealloy:main Dec 20, 2024
27 checks passed
This was referenced Dec 20, 2024
Closed
Open
Open
This was referenced Dec 20, 2024
Open
Open
Closed
Open
Closed
This was referenced Dec 30, 2024
Open
Open
Open
Open
Open
This was referenced Jan 7, 2025
Open
Open
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rakita rakita rakita approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@lancorer @rakita