Skip to content

Commit ad92ad2

Browse files
committed
docs: improve displaying GitHub API links on pkg.go.dev
1 parent 3afe183 commit ad92ad2

19 files changed

+35
-0
lines changed

github/activity_events.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ func (s *ActivityService) ListEventsForOrganization(ctx context.Context, org str
143143
// true, only public events will be returned.
144144
//
145145
// GitHub API docs: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user
146+
//
146147
// GitHub API docs: https://docs.github.com/rest/activity/events#list-public-events-for-a-user
147148
//
148149
//meta:operation GET /users/{username}/events
@@ -177,6 +178,7 @@ func (s *ActivityService) ListEventsPerformedByUser(ctx context.Context, user st
177178
// true, only public events will be returned.
178179
//
179180
// GitHub API docs: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user
181+
//
180182
// GitHub API docs: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user
181183
//
182184
//meta:operation GET /users/{username}/received_events

github/activity_star.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ type ActivityListStarredOptions struct {
6969
// will list the starred repositories for the authenticated user.
7070
//
7171
// GitHub API docs: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user
72+
//
7273
// GitHub API docs: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user
7374
//
7475
//meta:operation GET /user/starred

github/activity_watching.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ func (s *ActivityService) ListWatchers(ctx context.Context, owner, repo string,
5555
// the empty string will fetch watched repos for the authenticated user.
5656
//
5757
// GitHub API docs: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user
58+
//
5859
// GitHub API docs: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-the-authenticated-user
5960
//
6061
//meta:operation GET /user/subscriptions

github/apps.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,7 @@ func (i Installation) String() string {
215215
// (e.g., https://github.com/settings/apps/:app_slug).
216216
//
217217
// GitHub API docs: https://docs.github.com/rest/apps/apps#get-an-app
218+
//
218219
// GitHub API docs: https://docs.github.com/rest/apps/apps#get-the-authenticated-app
219220
//
220221
//meta:operation GET /app

github/apps_marketplace.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ type MarketplacePurchaseAccount struct {
9090
// ListPlans lists all plans for your Marketplace listing.
9191
//
9292
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#list-plans
93+
//
9394
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#list-plans-stubbed
9495
//
9596
//meta:operation GET /marketplace_listing/plans
@@ -118,6 +119,7 @@ func (s *MarketplaceService) ListPlans(ctx context.Context, opts *ListOptions) (
118119
// ListPlanAccountsForPlan lists all GitHub accounts (user or organization) on a specific plan.
119120
//
120121
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan
122+
//
121123
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed
122124
//
123125
//meta:operation GET /marketplace_listing/plans/{plan_id}/accounts
@@ -146,6 +148,7 @@ func (s *MarketplaceService) ListPlanAccountsForPlan(ctx context.Context, planID
146148
// GetPlanAccountForAccount get GitHub account (user or organization) associated with an account.
147149
//
148150
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account
151+
//
149152
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed
150153
//
151154
//meta:operation GET /marketplace_listing/accounts/{account_id}
@@ -170,6 +173,7 @@ func (s *MarketplaceService) GetPlanAccountForAccount(ctx context.Context, accou
170173
// ListMarketplacePurchasesForUser lists all GitHub marketplace purchases made by a user.
171174
//
172175
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user
176+
//
173177
// GitHub API docs: https://docs.github.com/rest/apps/marketplace#list-subscriptions-for-the-authenticated-user-stubbed
174178
//
175179
//meta:operation GET /user/marketplace_purchases

github/gists.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ type GistListOptions struct {
9797
// user.
9898
//
9999
// GitHub API docs: https://docs.github.com/rest/gists/gists#list-gists-for-a-user
100+
//
100101
// GitHub API docs: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user
101102
//
102103
//meta:operation GET /gists

github/issues.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ type IssueType struct {
160160
// repositories.
161161
//
162162
// GitHub API docs: https://docs.github.com/rest/issues/issues#list-issues-assigned-to-the-authenticated-user
163+
//
163164
// GitHub API docs: https://docs.github.com/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user
164165
//
165166
//meta:operation GET /issues

github/issues_comments.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ type IssueListCommentsOptions struct {
5555
// number of 0 will return all comments on all issues for the repository.
5656
//
5757
// GitHub API docs: https://docs.github.com/rest/issues/comments#list-issue-comments
58+
//
5859
// GitHub API docs: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository
5960
//
6061
//meta:operation GET /repos/{owner}/{repo}/issues/comments

github/orgs.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ func (s *OrganizationsService) ListAll(ctx context.Context, opts *OrganizationsL
194194
// organizations for the authenticated user.
195195
//
196196
// GitHub API docs: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user
197+
//
197198
// GitHub API docs: https://docs.github.com/rest/orgs/orgs#list-organizations-for-the-authenticated-user
198199
//
199200
//meta:operation GET /user/orgs

github/orgs_members.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ type ListMembersOptions struct {
7272
// public members; otherwise, it will only return public members.
7373
//
7474
// GitHub API docs: https://docs.github.com/rest/orgs/members#list-organization-members
75+
//
7576
// GitHub API docs: https://docs.github.com/rest/orgs/members#list-public-organization-members
7677
//
7778
//meta:operation GET /orgs/{org}/members
@@ -237,6 +238,7 @@ func (s *OrganizationsService) ListOrgMemberships(ctx context.Context, opts *Lis
237238
// authenticated user.
238239
//
239240
// GitHub API docs: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user
241+
//
240242
// GitHub API docs: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user
241243
//
242244
//meta:operation GET /orgs/{org}/memberships/{username}
@@ -268,6 +270,7 @@ func (s *OrganizationsService) GetOrgMembership(ctx context.Context, user, org s
268270
// authenticated user.
269271
//
270272
// GitHub API docs: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user
273+
//
271274
// GitHub API docs: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user
272275
//
273276
//meta:operation PUT /orgs/{org}/memberships/{username}

0 commit comments

Comments
 (0)