search

google / benchmark

A microbenchmark support library
Apache License 2.0
8.61k stars 1.57k forks source link

Update tools.md for missing color meaning issue #1491 #1624

Closed varshneydevansh closed 1 year ago

varshneydevansh commented 1 year ago

Issue >

Null hypothesis test discrepancy #1491

Solution Proposed >

documentation needs to be enhanced

Changes made >

Added the lines to the tools.md file which explains the following -

  1. Clarify the meaning of the colors in the output.
  2. Defining the 'success' and 'failure' explicitly.
  3. Clarify the interpretation of the p-value and the null hypothesis.
LebedevRI commented 1 year ago

@dmah42 someone more fluent in english will need to proofread the wording, i can only mostly help with the content here.

dmah42 commented 1 year ago

@dmah42 someone more fluent in english will need to proofread the wording, i can only mostly help with the content here.

seems good to me. feel free to merge it whenever you're happy with the content.

varshneydevansh commented 1 year ago

Thank you so much @LebedevRI for guiding me. I recently encountered benchmarking for the first time and began learning about it. Then I realized that this is something where, alongside learning, I can even contribute.

I learned a lot from this process, not just about benchmarking, but how to organize thoughts in a way that makes it easier to understand for others.

Regards.