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 Summary #64

Open
hendriknielaender opened this issue Mar 17, 2024 · 0 comments
Open

Benchmark Summary #64

hendriknielaender opened this issue Mar 17, 2024 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@hendriknielaender
Copy link
Owner

Description

One feature that would significantly enhance its utility is the addition of a summary of the benchmarks at the end of its output, similar to the functionality offered by the hyperfine command-line tool.

Proposed Feature Details

The summary would be implemented as a method in the Benchmark class. This method would be responsible for formatting and displaying the summary. Here's a high-level overview of what the summary would include:

  • A bold "Summary" heading.
  • The name of the benchmark that ran the fastest, highlighted in green.
  • A comparison of each subsequent benchmark, showing how many times slower they are compared to the fastest one. This would be visually distinguished with indentation and color coding (e.g., green for the times faster value and blue for the benchmark name).

Use Case

This feature would be particularly useful for developers looking to:

  • Quickly assess the performance characteristics of their code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
1 participant