Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve documentation on consume #1125

Open
marioevz opened this issue Jan 24, 2025 · 3 comments · Fixed by #1147
Open

Improve documentation on consume #1125

marioevz opened this issue Jan 24, 2025 · 3 comments · Fixed by #1147
Assignees
@Emirhan-Cavusoglu-sftw
Labels
good first issue Good for newcomers scope:consume Scope: Consume command suite

Comments

@marioevz
Copy link
Member

At the moment, the only information we provide about the command is in the --help flag of the command itself.

We could add a subsection to the "Consuming Tests" section of the documentation, including:

  • What is consume.
  • When should it be used.
  • How to use it.
  • Examples and hive considerations (namely, the --dev mode and the --client-config flag).
@marioevz marioevz added good first issue Good for newcomers scope:consume Scope: Consume command suite labels Jan 24, 2025
@Emirhan-Cavusoglu-sftw
Copy link
Contributor

Can you assign me

@marioevz
Copy link
Member Author

Can you assign me

Just did, thanks! If you need help let me know here 👍

Merged
4 tasks
@danceratopz
Copy link
Member

Futher work/PRs on this should be based on https://github.com/ethereum/execution-spec-tests/tree/consume-docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Emirhan-Cavusoglu-sftw Emirhan-Cavusoglu-sftw

Labels
good first issue Good for newcomers scope:consume Scope: Consume command suite
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(consume): add consume command documentation Emirhan-Cavusoglu-sftw/execution-spec-tests
3 participants
@marioevz @danceratopz @Emirhan-Cavusoglu-sftw