Skip to content

Commit 22f7fe3

Browse files
authored
Fix spelling issues (#3792)
1 parent ab86053 commit 22f7fe3

23 files changed

+33
-33
lines changed

github/actions_workflow_runs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ func (s *ActionsService) getWorkflowRunAttemptLogsWithRateLimit(ctx context.Cont
306306
}
307307

308308
// RerunWorkflowByID re-runs a workflow by ID.
309-
// You can use the helper function *DeploymentProtectionRuleEvent.GetRunID() to easily retrieve the workflow run ID a the DeploymentProtectionRuleEvent.
309+
// You can use the helper function *DeploymentProtectionRuleEvent.GetRunID() to easily retrieve the workflow run ID of a DeploymentProtectionRuleEvent.
310310
//
311311
// GitHub API docs: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow
312312
//

github/activity_star.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ type ActivityListStarredOptions struct {
5959
Sort string `url:"sort,omitempty"`
6060

6161
// Direction in which to sort repositories. Possible values are: asc, desc.
62-
// Default is "asc" when sort is "full_name", otherwise default is "desc".
62+
// Default is "asc" when sort is "full_name"; otherwise, default is "desc".
6363
Direction string `url:"direction,omitempty"`
6464

6565
ListOptions

github/billing.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,13 @@ type PremiumRequestUsageReportOptions struct {
106106
// If no year or month is specified, the default year and month are used.
107107
Day *int `url:"day,omitempty"`
108108

109-
// The user name to query usage for. The name is not case sensitive.
109+
// The user name to query usage for. The name is not case-sensitive.
110110
User *string `url:"user,omitempty"`
111111

112-
// The model name to query usage for. The name is not case sensitive.
112+
// The model name to query usage for. The name is not case-sensitive.
113113
Model *string `url:"model,omitempty"`
114114

115-
// The product name to query usage for. The name is not case sensitive.
115+
// The product name to query usage for. The name is not case-sensitive.
116116
Product *string `url:"product,omitempty"`
117117
}
118118

github/doc.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For more sample code snippets, head over to the https://github.com/google/go-git
4040
4141
# Authentication
4242
43-
Use [Client.WithAuthToken] to configure your client to authenticate using an Oauth token
43+
Use [Client.WithAuthToken] to configure your client to authenticate using an OAuth token
4444
(for example, a personal access token). This is what is needed for a majority of use cases
4545
aside from GitHub Apps.
4646

github/enterprise_actions_runners.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ func (s *EnterpriseService) CreateRegistrationToken(ctx context.Context, enterpr
7575
return registrationToken, resp, nil
7676
}
7777

78-
// ListRunners lists all the self-hosted runners for a enterprise.
78+
// ListRunners lists all the self-hosted runners for an enterprise.
7979
//
8080
// GitHub API docs: https://docs.github.com/enterprise-cloud@latest/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise
8181
//

github/enterprise_network_configurations_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,7 @@ func TestEnterpriseService_GetEnterpriseNetworkSettingsResource(t *testing.T) {
385385
Region: Ptr("germanywestcentral"),
386386
}
387387
if !cmp.Equal(resource, want) {
388-
t.Errorf("Enterprise.GetEnterpriseNetworkSettingsResource mistach (-want +got):\n%v", cmp.Diff(want, resource))
388+
t.Errorf("Enterprise.GetEnterpriseNetworkSettingsResource mismatch (-want +got):\n%v", cmp.Diff(want, resource))
389389
}
390390

391391
const methodName = "GetEnterpriseNetworkSettingsResource"

github/event_types.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ type DeploymentProtectionRuleEvent struct {
265265
Environment *string `json:"environment,omitempty"`
266266
Event *string `json:"event,omitempty"`
267267

268-
// The URL Github provides for a third-party to use in order to pass/fail a deployment gate
268+
// The URL GitHub provides for a third-party to use in order to pass/fail a deployment gate
269269
DeploymentCallbackURL *string `json:"deployment_callback_url,omitempty"`
270270
Deployment *Deployment `json:"deployment,omitempty"`
271271
Repo *Repository `json:"repository,omitempty"`
@@ -859,7 +859,7 @@ type MergeGroup struct {
859859
HeadRef *string `json:"head_ref,omitempty"`
860860
// The SHA of the merge group's parent commit.
861861
BaseSHA *string `json:"base_sha,omitempty"`
862-
// The full ref of the branch the merge group will be merged into.
862+
// The full ref of the branch into which the merge group will be merged.
863863
BaseRef *string `json:"base_ref,omitempty"`
864864
// An expanded representation of the head_sha commit.
865865
HeadCommit *Commit `json:"head_commit,omitempty"`
@@ -1845,7 +1845,7 @@ type WatchEvent struct {
18451845
}
18461846

18471847
// WorkflowDispatchEvent is triggered when someone triggers a workflow run on GitHub or
1848-
// sends a POST request to the create a workflow dispatch event endpoint.
1848+
// sends a POST request to the endpoint to create a workflow dispatch event.
18491849
//
18501850
// GitHub API docs: https://docs.github.com/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch
18511851
type WorkflowDispatchEvent struct {

github/github.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -850,7 +850,7 @@ const (
850850

851851
// bareDo sends an API request using `caller` http.Client passed in the parameters
852852
// and lets you handle the api response. If an error or API Error occurs, the error
853-
// will contain more information. Otherwise you are supposed to read and close the
853+
// will contain more information. Otherwise, you are supposed to read and close the
854854
// response's Body. If rate limit is exceeded and reset time is in the future,
855855
// bareDo returns *RateLimitError immediately without making a network API call.
856856
//
@@ -967,7 +967,7 @@ func (c *Client) bareDo(ctx context.Context, caller *http.Client, req *http.Requ
967967
}
968968

969969
// BareDo sends an API request and lets you handle the api response. If an error
970-
// or API Error occurs, the error will contain more information. Otherwise you
970+
// or API Error occurs, the error will contain more information. Otherwise, you
971971
// are supposed to read and close the response's Body. If rate limit is exceeded
972972
// and reset time is in the future, BareDo returns *RateLimitError immediately
973973
// without making a network API call.

github/orgs_members.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ type ListMembersOptions struct {
6969

7070
// ListMembers lists the members for an organization. If the authenticated
7171
// user is an owner of the organization, this will return both concealed and
72-
// public members, otherwise it will only return public members.
72+
// public members; otherwise, it will only return public members.
7373
//
7474
// GitHub API docs: https://docs.github.com/rest/orgs/members#list-organization-members
7575
// GitHub API docs: https://docs.github.com/rest/orgs/members#list-public-organization-members

github/packages.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ func (mt PackageEventContainerMetadataTag) String() string {
264264

265265
// PackageNugetMetadata represents nuget metadata for a GitHub package.
266266
type PackageNugetMetadata struct {
267-
ID json.RawMessage `json:"id,omitempty"` // Can either be a int64 or string
267+
ID json.RawMessage `json:"id,omitempty"` // Can either be an int64 or string
268268
Name *string `json:"name,omitempty"`
269269
Value json.RawMessage `json:"value,omitempty"` // Can either be a bool, string, integer or object
270270
}

0 commit comments

Comments
 (0)