Skip to content

docs: fix phrasing and punctuation in doc comments #4461

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.

Sign up for GitHub

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

Open
aoright wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −3
Open

docs: fix phrasing and punctuation in doc comments #4461

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions github/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ const (
// After some time, specific media types will be promoted (to a "stable" state).
// From then on, the preview headers are not required anymore to activate the additional
// feature on GitHub.com's API. However, this API header might still be needed for users
// to run a GitHub Enterprise Server on-premise.
// to run a GitHub Enterprise Server on-premises.
// It's not uncommon for GitHub Enterprise Server customers to run older versions which
// would probably rely on the preview headers for some time.
// While the header promotion is going out for GitHub.com, it may be some time before it
Expand Down Expand Up @@ -196,10 +196,10 @@ type Client struct {
secondaryRateLimitReset time.Time // Secondary rate limit reset for the client as determined by the most recent API calls.

// If specified, Client will block requests for at most this duration in case of reaching a secondary
// rate limit
// rate limit.
maxSecondaryRateLimitRetryAfterDuration time.Duration

// Whether to respect rate limit headers on endpoints that return 302 redirections to artifacts
// Whether to respect rate limit headers on endpoints that return 302 redirections to artifacts.
rateLimitRedirectionalEndpoints bool

common service // Reuse a single struct instead of allocating one for each service on the heap.
Expand Down