This repository was archived by the owner on Jan 12, 2026. It is now read-only.
docs: improve documentation and fix typos#37
Open
AdekunleBamz wants to merge 1 commit intobase:mainfrom
Open
Conversation
- Fix typos in README.md ('tranctions' -> 'transactions', 'locall' -> 'locally')
- Add comprehensive documentation to gas_limiter module (args.rs, error.rs)
- Fix incorrect unit in GasLimitError message ('gwei' -> 'gas units')
- Add module-level documentation to traits.rs with trait descriptions
- Enhance execution.rs with detailed documentation for TxnExecutionResult and ExecutionInfo
These changes improve code readability and help new contributors understand
the codebase better.
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Summary
This PR improves code documentation and fixes minor typos to enhance code readability and help new contributors understand the codebase better.
Changes
Documentation Improvements
NodeBounds,NodeComponents,PoolBounds,ClientBounds,PayloadTxsBounds)TxnExecutionResultenum variants andExecutionInfostruct with detailed explanations of each field's purposeBug Fixes
GasLimitErrormessage: changed "gwei" to "gas units" since the values represent gas units, not gweiTypo Fixes
Testing
Related Issues
N/A