@@ -18,10 +18,10 @@ again.
1818## Reporting issues
1919
2020Bugs, feature requests, and development-related questions should be directed to
21- our [ GitHub issue tracker] ( https://github.com/google/go-github/issues ) . If
21+ our [ GitHub issue tracker] ( https://github.com/google/go-github/issues ) . If
2222reporting a bug, please try and provide as much context as possible such as
2323your operating system, Go version, and anything else that might be relevant to
24- the bug. For feature requests, please explain what you're trying to do, and
24+ the bug. For feature requests, please explain what you're trying to do, and
2525how the requested feature would help you do that.
2626
2727Security related bugs can either be reported in the issue tracker, or if they
@@ -163,20 +163,20 @@ Every exported method and type needs to have code comments that follow
163163//
164164// meta:operation GET /repos/{owner}/{repo}
165165func (s *RepositoriesService ) Get (ctx context .Context , owner , repo string ) (*Repository , *Response , error ) {
166- u := fmt.Sprintf (" repos/%v /%v " , owner, repo)
167- req , err := s.client .NewRequest (ctx, " GET" , u, nil )
168- ...
166+ u := fmt.Sprintf (" repos/%v /%v " , owner, repo)
167+ req , err := s.client .NewRequest (ctx, " GET" , u, nil )
168+ // ...
169169}
170170```
171171And the returned type ` Repository ` will have comments like this:
172172
173173``` go
174174// Repository represents a GitHub repository.
175175type Repository struct {
176- ID *int64 ` json:"id,omitempty"`
177- NodeID *string ` json:"node_id,omitempty"`
178- Owner *User ` json:"owner,omitempty"`
179- ...
176+ ID *int64 ` json:"id,omitempty"`
177+ NodeID *string ` json:"node_id,omitempty"`
178+ Owner *User ` json:"owner,omitempty"`
179+ // ...
180180}
181181```
182182
0 commit comments