Enable lint check for comments #2023
Conversation
This change addresses all comment-related linter errors by doing the following: - Add comments to exported symbols - Make some exported symbols private - Recommend via TODOs that some exported symbols should should move or be removed This PR does not: - Modify, move, or remove any code - Modify existing comments Signed-off-by: Andrew Seigner <siggy@buoyant.io>
|
Relates to #216. |
| @@ -5,6 +5,8 @@ import ( | |||
| "google.golang.org/grpc" | |||
| ) | |||
|
|
|||
| // NewClient creates a new gRPC client to the Destination service. | |||
| // TODO: consider moving this into destination-client, or removing altogether. | |||
There was a problem hiding this comment.
👍 Looks like this is only called from the destination-client script, so I'm definitely in favor of removing this file and moving the code directly into the script. But doesn't necessarily have to happen as part of this branch.
There was a problem hiding this comment.
Sounds good, will address in a subsequent PR.
controller/api/public/client.go
Outdated
| @@ -190,6 +190,7 @@ func newClient(apiURL *url.URL, httpClientToUse *http.Client, controlPlaneNamesp | |||
| }, nil | |||
| } | |||
|
|
|||
| // NewInternalClient creates a new Public API client intended to run inside a Kubernetes cluster. | |||
There was a problem hiding this comment.
Mind wrapping this at 80 characters? Same goes for the comment on line 203 in this file.
controller/api/public/test_helper.go
Outdated
| Res model.Value | ||
| QueriesExecuted []string // expose the queries our Mock Prometheus receives, to test query generation | ||
| rwLock sync.Mutex | ||
| } | ||
|
|
||
| // PodCounts is a test helper struct that for representing data in a |
There was a problem hiding this comment.
Typo here. Maybe it should be: // PodCounts is a test helper struct that is used for representing data in a
| @@ -535,6 +547,8 @@ func routeLabels(event *pb.TapEvent) string { | |||
| return out | |||
| } | |||
|
|
|||
| // RenderTapEvent renders a Public API TapEvent to a string. | |||
| // TODO: consider moving this into cli/cmd/tap.go. | |||
There was a problem hiding this comment.
👍 Ah, right, this was originally moved here when we were rendering tap output as plaintext in the web UI, but we could move it back now that the web has its own rendering.
There was a problem hiding this comment.
Will do in a subsequent PR.
controller/k8s/api.go
Outdated
| func (api *API) Pod() coreinformers.PodInformer { | ||
| if api.pod == nil { | ||
| panic("Pod informer not configured") | ||
| } | ||
| return api.pod | ||
| } | ||
|
|
||
| // RC provides access to a shared informer and lister for ReplicaSets. |
There was a problem hiding this comment.
Typo here: ReplicaSets => ReplicationControllers
Signed-off-by: Andrew Seigner <siggy@buoyant.io>
This is a followup branch from #2023: - delete `proxy/client.go`, move code to `destination-client` - move `RenderTapEvent` and `GetPercentTLS` from `util` to `cmd` Signed-off-by: Andrew Seigner <siggy@buoyant.io>
This is a followup branch from #2023: - delete `proxy/client.go`, move code to `destination-client` - move `RenderTapEvent` and stat functions from `util` to `cmd` Signed-off-by: Andrew Seigner <siggy@buoyant.io>
Part of #217. Follow up from #1982 and #2018.
A subsequent commit will fix the ci failure.
Signed-off-by: Andrew Seigner siggy@buoyant.io
2nd commit
Address all comment-related linter errors.
This change addresses all comment-related linter errors by doing the
following:
be removed
This PR does not:
Signed-off-by: Andrew Seigner siggy@buoyant.io