Skip to content

docs: Improve formatting in README - #3300

Merged
gmlewis merged 3 commits into
google:masterfrom
alexandear-org:docs/improve-readme
Oct 4, 2024
Merged

docs: Improve formatting in README#3300
gmlewis merged 3 commits into
google:masterfrom
alexandear-org:docs/improve-readme

Conversation

@alexandear

@alexandearalexandear commented Oct 3, 2024

Copy link
Copy Markdown
Contributor

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
alexandearforce-pushed the docs/improve-readme branch 2 times, most recently from e8622af to 629da9aCompareOctober 3, 2024 10:33
@codecov

codecovBot commented Oct 3, 2024

Copy link
Copy Markdown

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.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated

@gmlewisgmlewis left a comment

Copy link
Copy Markdown
Collaborator

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.

Comment threadREADME.md Outdated
Comment threadREADME.md Outdated
Comment threadREADME.md Outdated

@gmlewisgmlewis left a comment

Copy link
Copy Markdown
Collaborator

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.

Sign up for freeto 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.

3 participants

@alexandear@gmlewis@Parker77