Skip to content

Commit

Permalink
all: make function and struct comments match the names
Browse files Browse the repository at this point in the history
Change-Id: I1277ea35dd14f6023534636335d13bf3c6859c67
Reviewed-on: https://go-review.googlesource.com/c/build/+/639556
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Ian Lance Taylor <[email protected]>
Auto-Submit: Ian Lance Taylor <[email protected]>
Reviewed-by: Carlos Amedee <[email protected]>
  • Loading branch information
cuishuang authored and gopherbot committed Jan 2, 2025
1 parent bf50695 commit b70670f
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions buildlet/buildlet.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ type VMOpts struct {
// after the instance operation succeeds.
OnInstanceCreated func()

// OnInstanceCreated optionally specifies a hook to run synchronously
// OnGotInstanceInfo optionally specifies a hook to run synchronously
// after the computeService.Instances.Get call.
// Only valid for GCE resources.
OnGotInstanceInfo func(*compute.Instance)

// OnInstanceCreated optionally specifies a hook to run synchronously
// OnGotEC2InstanceInfo optionally specifies a hook to run synchronously
// after the EC2 instance information is retrieved.
// Only valid for EC2 resources.
OnGotEC2InstanceInfo func(*cloud.Instance)
Expand Down
2 changes: 1 addition & 1 deletion internal/coordinator/pool/ec2.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ type EC2Buildlet struct {
// hosts provides the host configuration for all hosts. It is passed in to facilitate
// testing.
hosts map[string]*dashboard.HostConfig
// isRemoteBuildletFunc informs the caller is a VM instance is being used as a remote
// isRemoteBuildlet informs the caller is a VM instance is being used as a remote
// buildlet.
//
// TODO(golang.org/issues/38337) remove once we find a way to pass in remote buildlet
Expand Down
2 changes: 1 addition & 1 deletion internal/coordinator/pool/reverse.go
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ type reverseBuildlet struct {
// It is the key into the dashboard.Hosts map.
hostType string

// inUseAs signifies that the buildlet is in use.
// inUse signifies that the buildlet is in use.
// inUseTime is when it entered that state.
// inHealthCheck is whether it's inUse due to a health check.
// All three are guarded by the mutex on ReverseBuildletPool.
Expand Down
2 changes: 1 addition & 1 deletion internal/iapclient/iapclient.go
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ func cachedToken() (*oauth2.Token, error) {
return &refreshToken, nil
}

// TokenSource returns a TokenSource that can be used to access Go's
// TokenSourceForceLogin returns a TokenSource that can be used to access Go's
// IAP-protected sites. It will delete any existing authentication token
// credentials and prompt for login.
func TokenSourceForceLogin(ctx context.Context) (oauth2.TokenSource, error) {
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/api/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1739,7 +1739,7 @@ type NodeStatus struct {
// Queried from cloud provider, if available.
// More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-addresses
Addresses []NodeAddress `json:"addresses,omitempty" patchStrategy:"merge" patchMergeKey:"type"`
// NodeSystemInfo is a set of ids/uuids to uniquely identify the node.
// NodeInfo is a set of ids/uuids to uniquely identify the node.
// More info: http://releases.k8s.io/HEAD/docs/admin/node.md#node-info
NodeInfo NodeSystemInfo `json:"nodeInfo,omitempty"`
}
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import (
type Client struct {
httpClient *http.Client

// endPointURL is the Kubernetes master URL ending in
// endpointURL is the Kubernetes master URL ending in
// "/api/v1".
endpointURL string

Expand Down
2 changes: 1 addition & 1 deletion maintner/github.go
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ type GitHubComment struct {
Body string
}

// GitHubDismissedReview is the contents of a dismissed review event. For more
// GitHubDismissedReviewEvent is the contents of a dismissed review event. For more
// details, see https://developer.github.com/v3/issues/events/.
type GitHubDismissedReviewEvent struct {
ReviewID int64
Expand Down

0 comments on commit b70670f

Please sign in to comment.