chore(fw): add docstrings to all opcodes in opcodes enum (#424)

Co-authored-by: Mario Vega <[email protected]> Co-authored-by: danceratopz <[email protected]> Co-authored-by: spencer-tb <[email protected]>
ethereum · Feb 27, 2024 · bc1a154 · bc1a154
1 parent 904ceb5
commit bc1a154
Show file tree

Hide file tree

Showing 3 changed files with 4,555 additions and 65 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -18,6 +18,7 @@ Test fixtures for use by clients are available for each release on the [Github r
 - ✨ Improve handling of the argument passed to `solc --evm-version` when compiling Yul code ([#418](https://github.com/ethereum/execution-spec-tests/pull/418)).
 - 🐞 Fix `fill -m yul_test` which failed to filter tests that are (dynamically) marked as a yul test ([#418](https://github.com/ethereum/execution-spec-tests/pull/418)).
 - 🔀 Helper methods `to_address`, `to_hash` and `to_hash_bytes` have been deprecated in favor of `Address` and `Hash`, which are automatically detected as opcode parameters and pushed to the stack in the resulting bytecode ([#422](https://github.com/ethereum/execution-spec-tests/pull/422)).
+- ✨ `Opcodes` enum now contains docstrings with each opcode description, including parameters and return values, which show up in many development environments ([#424](https://github.com/ethereum/execution-spec-tests/pull/424)) @ThreeHrSleep.
 
 ### 🔧 EVM Tools