Skip to content

docs: Improve formatting in README #3300

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

Merged
merged 3 commits into from
Oct 4, 2024

Conversation

alexandear
Copy link
Contributor

@alexandear alexandear commented Oct 3, 2024

The PR improves formatting in README.md:

  • replace outdated godoc.org with pkg.go.dev;
  • set text link for raw URLs;
  • replace whitespace with TAB in Go example code;
  • add missing ### for some titles;

@alexandear alexandear force-pushed the docs/improve-readme branch 2 times, most recently from e8622af to 629da9a Compare October 3, 2024 10:33
@alexandear alexandear force-pushed the docs/improve-readme branch from 629da9a to 5a60878 Compare October 3, 2024 10:34
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.05%. Comparing base (2b8c7fa) to head (90cb24e).
Report is 133 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3300      +/-   ##
==========================================
- Coverage   97.72%   93.05%   -4.67%     
==========================================
  Files         153      172      +19     
  Lines       13390    11772    -1618     
==========================================
- Hits        13085    10955    -2130     
- Misses        215      723     +508     
- Partials       90       94       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @alexandear !
Just a few nits, please, then we should be ready to merge.

Copy link
Collaborator

@gmlewis gmlewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @alexandear !
LGTM.
Merging.

@gmlewis gmlewis merged commit 4fcbdf8 into google:master Oct 4, 2024
6 of 7 checks passed
@alexandear alexandear deleted the docs/improve-readme branch October 10, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants