search

google / benchmark

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

Update README.md #1759

Closed 14jdelap closed 3 months ago

14jdelap commented 4 months ago

Remove the $ at the start of the bash command to run the tests so that it can be copy-pasted by a user without any errors

This change is consistent with the other 1-line bash snippets in the readme

google-cla[bot] commented 4 months ago

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

LebedevRI commented 4 months ago

I'm not sure what we should be doing, but this is not consistent, there's only one snippet that does not use $'s.

14jdelap commented 4 months ago

Thinking about it now, my suggestions would be to remove all the $ symbols from the snippets of bash code (including the large one in Installation).

The result of that would be that anyone would be able to copy-paste the code with the symbol that Github provides, whereas now it generates an error because you need to remove the $s.

Tbh this is a very minor detail, so if you disagree I'm happy to close this.

dmah42 commented 4 months ago

i agree with your assessment that we should get rid of them. they're a holdover from pre-markdown/github notes for the most part where differentiating a "command" was more important.

LebedevRI commented 4 months ago

FWIW, if i had to guess, i'd go the opposite route. Because "randomly" pasting bash snippets from somewhere is not something that should be done. But i digress.