docs: add documentation for EVM opcode offset constants #4760
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.
What I did
Added documentation comments to EVM opcode offset constants (
PUSH_OFFSET,DUP_OFFSET,SWAP_OFFSET) in the assembler core module to improve code readability and developer understanding.How I did it
Added explanatory comments above each constant definition explaining:
OFFSET + instruction_numberHow to verify it
python3 -c "from vyper.evm.assembler.core import PUSH_OFFSET, DUP_OFFSET, SWAP_OFFSET; print(f'{PUSH_OFFSET}, {DUP_OFFSET}, {SWAP_OFFSET}')"python3 -m py_compile vyper/evm/assembler/core.pyCommit message
docs: add documentation for EVM opcode offset constantsDescription for the changelog
Added documentation comments to EVM assembler constants to clarify opcode encoding logic.
Cute Animal Picture