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

Fix minor formatting and documentation inconsistencies in README #1944

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

amolak21
Copy link

@amolak21 amolak21 commented Mar 8, 2025

This PR fixes minor inconsistencies and formatting issues in the README file.
Changes include:

  • Fixed indentation and markdown issues.
  • Updated C++ standard in the example (-std=c++11-std=c++14).
  • Corrected list formatting.

No functional changes were made to the benchmark code.

Copy link

google-cla bot commented Mar 8, 2025

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.

@amolak21
Copy link
Author

amolak21 commented Mar 8, 2025

Hi, I've updated the documentation as per issue #1943. Could someone please review it when available?

@amolak21
Copy link
Author

amolak21 commented Mar 8, 2025

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.

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.

I have signed the CLA

@amolak21 amolak21 closed this Mar 8, 2025
@amolak21 amolak21 reopened this Mar 8, 2025
@LebedevRI
Copy link
Collaborator

I don't see the change the PR subject is talking about.

@amolak21 amolak21 changed the title Docs : Clarify usage of BENCHMARK_MAIN() in documentation Fix minor formatting and documentation inconsistencies in README Mar 8, 2025
@amolak21
Copy link
Author

amolak21 commented Mar 8, 2025

I have updated the PR title and description to better reflect the changes.
Please review when you get a chance.

@LebedevRI
Copy link
Collaborator

CLA check still seems to be having issues.

@dmah42
Copy link
Member

dmah42 commented Mar 12, 2025

forced a rescan

@LebedevRI
Copy link
Collaborator

Not that i care either way, but i'm a bit confused by the rest of the changes here -- both the old and the new variants are equivalent as far as MarkDown is concerned, no?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants