Skip to content

docs: Fix phrasing and punctuation in doc comments - #4652

Merged
gmlewis merged 1 commit into
google:masterfrom
JamBalaya56562:docs/4461-doc-comment-fixes
Oct 21, 2026
Merged

gmlewis merged 1 commit into
google:masterfrom
JamBalaya56562:docs/4461-doc-comment-fixes

Conversation

@JamBalaya56562

@JamBalaya56562 JamBalaya56562 commented Oct 20, 2026 •

Copy link
Copy Markdown
Contributor

Closes: #4461.

Supersedes #4461 by @aoright, which has been waiting on the Google CLA since August. This is the same change on current master; thanks to @aoright for the original fix.

  • In github/github.go, correct on-premise to on-premises in the media types preview comment.
  • Add the missing trailing periods to two Client struct field comments.

Verified locally: gofmt, go build ./..., go vet ./github/, and custom-gcl 0 issues.

@codecov

codecov Bot commented Oct 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.62%. Comparing base (28d2616) to head (fe6fd59).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4652   +/-   ##
=======================================
  Coverage   98.62%   98.62%           
=======================================
  Files         201      201           
  Lines       18811    18811           
=======================================
  Hits        18553    18553           
  Misses        258      258           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@gmlewis

gmlewis commented Oct 20, 2026 •

Copy link
Copy Markdown
Collaborator

Thank you, @JamBalaya56562 , and for the nice comments and generous offer. I'm hoping we can move forward with your offer.

Since you may be the new maintainer soon, if you change "Superseeds" to "Closes" in the PR's description, then GitHub will automatically close that PR when this one merges. 😁

@gmlewis gmlewis 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.

LGTM.
Merging.

@gmlewis
gmlewis merged commit 2190e6a into google:master Oct 21, 2026
15 checks passed
@JamBalaya56562
JamBalaya56562 deleted the docs/4461-doc-comment-fixes branch October 21, 2026 18:56
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.

2 participants