Fix documentation errors in PR #82 review comments#83
Merged
Conversation
Changed Files
|
Merged
Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Clean up documentation and organization of Jet LLVM-based EVM JIT compiler
Fix documentation errors in PR #82 review comments
Feb 16, 2026
There was a problem hiding this comment.
Pull request overview
This PR corrects four documentation inaccuracies identified during the review of PR #82. All changes align the documentation with the actual implementation and test coverage status. The changes are purely documentation fixes with no code modifications.
Changes:
- Updated KECCAK256 status from "Broken" to "Tested" in test coverage documentation
- Fixed Word type endianness documentation from big-endian to little-endian
- Corrected stack helper function name from
__stack_pop_1tostack_pop_1in process documentation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/test_coverage.md | Updated KECCAK256 status to reflect working implementation with test coverage (lines 22, 59) |
| crates/jet_runtime/src/exec.rs | Corrected Word type documentation to specify little-endian storage (line 11) |
| docs/process/new-runtime-function.md | Fixed stack helper function name to match actual API without leading underscores (line 118) |
tcrypt25519
added a commit
that referenced
this pull request
Feb 16, 2026
* docs: Uodate architecture doc. * tweak: Reduce non-required pub visibility. * docs: Add rustdoc comments. * docs: Update docs. * fix * chore: CI change 🤖 * Fix documentation errors in PR #82 review comments (#83) * Initial plan * fix: address PR #82 review comments - correct documentation errors Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com>
tcrypt25519
added a commit
that referenced
this pull request
Feb 16, 2026
* docs: Uodate architecture doc. * tweak: Reduce non-required pub visibility. * docs: Add rustdoc comments. * docs: Update docs. * fix * chore: CI change 🤖 * Fix documentation errors in PR #82 review comments (#83) * Initial plan * fix: address PR #82 review comments - correct documentation errors Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com> --------- Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: tcrypt25519 <212655132+tcrypt25519@users.noreply.github.com>
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 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.
Addresses 4 documentation inaccuracies identified in PR #82 review.
Changes
Wordtype documentation from big-endian to little-endian (matches actual implementation usingfrom_le_bytes)__stack_pop_1tostack_pop_1(no leading underscores in actual API)All changes are documentation-only corrections aligned with existing implementation and test coverage.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.