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.

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

Benchmark documentation could use some improvements #14819

Open
carols10cents opened this issue Feb 21, 2025 · 0 comments · May be fixed by #14820
Open

Benchmark documentation could use some improvements #14819

carols10cents opened this issue Feb 21, 2025 · 0 comments · May be fixed by #14820
Labels
bug Something isn't working

Comments

@carols10cents
Copy link
Contributor

Describe the bug

There's some confusing, inaccurate information in the benchmarks/README.md, and there isn't any documentation on adding a new benchmark.

To Reproduce

Try to follow the benchmarks readme and see that there's at least one command that doesn't do what the text says it should do.

Try to use the benchmarks readme to know how to add a new benchmark... which isn't possible because that section doesn't exist 😅

Expected behavior

Expected the documentation to be correct and contain the information I was looking for 😅

Additional context

Don't worry, PR incoming in a minute!

@carols10cents carols10cents added the bug Something isn't working label Feb 21, 2025
@carols10cents carols10cents linked a pull request Feb 21, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant