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

Missing docs for bench CLI and API #1997

Closed
4 tasks done
nickserv opened this issue Sep 7, 2022 · 1 comment · Fixed by #2001
Closed
4 tasks done

Missing docs for bench CLI and API #1997

nickserv opened this issue Sep 7, 2022 · 1 comment · Fixed by #2001
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@nickserv
Copy link
Contributor

nickserv commented Sep 7, 2022

Clear and concise description of the problem

As far as I can tell, we haven't added any CLI or API docs for vitest bench and bench() yet.

Suggested solution

Document the benchmarking tool like we document other parts of the test runner.

Alternative

No response

Additional context

No response

Validations

@sheremet-va sheremet-va added the documentation Improvements or additions to documentation label Sep 8, 2022
@sheremet-va sheremet-va self-assigned this Sep 8, 2022
@FINDarkside
Copy link

FINDarkside commented Oct 1, 2022

I think the docs are still somewhat lacking, for example it seems like there's some pattern to match bench.ts files but I couldn't find any mention of it in docs. I just guessed since it seemed intuitive.

@github-actions github-actions bot locked and limited conversation to collaborators Jun 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants