Skip to content

Conversation

@LouisTsai-Csie
Copy link
Collaborator

@LouisTsai-Csie LouisTsai-Csie commented Nov 7, 2025

🗒️ Description

update docstrings in each benchmark test folder to indicate supported operations, improving collaboration with external contributors while documentation rendering is still pending.

🔗 Related Issues or PRs

None

✅ Checklist

  • All: Ran fast tox checks to avoid unnecessary CI fails, see also Code Standards and Enabling Pre-commit Checks:
    uvx tox -e static
  • All: PR title adheres to the repo standard - it will be used as the squash commit message and should start type(scope):.
  • All: Considered adding an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.
  • All: Set appropriate labels for the changes (only maintainers can apply labels).
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.
  • Tests: For PRs implementing a missed test case, update the post-mortem document to add an entry the list.
  • Ported Tests: All converted JSON/YML tests from ethereum/tests or tests/static have been assigned @ported_from marker.

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

@LouisTsai-Csie LouisTsai-Csie self-assigned this Nov 7, 2025
@LouisTsai-Csie LouisTsai-Csie added A-test-benchmark Area: Tests Benchmarks—Performance measurement (eg. `tests/benchmark/*`, `p/t/s/e/benchmark/*`) E-easy Experience: easy, good for newcomers C-refactor Category: refactor labels Nov 7, 2025
@LouisTsai-Csie LouisTsai-Csie force-pushed the doc/benchmark-doc-string branch from 781d58c to 96671dc Compare November 7, 2025 12:24
@LouisTsai-Csie LouisTsai-Csie marked this pull request as ready for review November 10, 2025 08:44
Copy link

@spencer-tb spencer-tb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT! Thanks :)

@spencer-tb spencer-tb merged commit f48b0bd into ethereum:forks/osaka Nov 10, 2025
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-test-benchmark Area: Tests Benchmarks—Performance measurement (eg. `tests/benchmark/*`, `p/t/s/e/benchmark/*`) C-refactor Category: refactor E-easy Experience: easy, good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants