Skip to content

Commit ed1e6bf

Browse files
committed
docs: revert code formatting changes in Code Comments examples
Revert the formatting changes to the code examples in the Code Comments section to match the original style with tabs and // ... comments, as requested in review feedback from gmlewis.
1 parent 130d1aa commit ed1e6bf

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -171,18 +171,18 @@ Every exported method and type needs to have code comments that follow
171171
func (s *RepositoriesService) Get(ctx context.Context, owner, repo string) (*Repository, *Response, error) {
172172
u := fmt.Sprintf("repos/%v/%v", owner, repo)
173173
req, err := s.client.NewRequest(ctx, "GET", u, nil)
174-
...
174+
// ...
175175
}
176176
```
177177
And the returned type `Repository` will have comments like this:
178178

179179
```go
180180
// Repository represents a GitHub repository.
181181
type Repository struct {
182-
ID *int64 `json:"id,omitempty"`
182+
ID *int64 `json:"id,omitempty"`
183183
NodeID *string `json:"node_id,omitempty"`
184-
Owner *User `json:"owner,omitempty"`
185-
...
184+
Owner *User `json:"owner,omitempty"`
185+
// ...
186186
}
187187
```
188188

0 commit comments

Comments
 (0)