Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Ping() to v2 client. #5598

Merged
merged 2 commits into from
Feb 10, 2016
Merged

Add Ping() to v2 client. #5598

merged 2 commits into from
Feb 10, 2016

Conversation

PSUdaemon
Copy link
Contributor

This was in the original client but did not make it to the v2 client. I think it's useful and have provided this patch.

Thanks.

@@ -119,6 +123,49 @@ func NewHTTPClient(conf HTTPConfig) (Client, error) {
}, nil
}

// Pings cluster
func (c *client) Ping(timeout time.Duration) (time.Duration, string, error) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

golint won't like this comment. Can you put something more descriptive, beginning with Ping.... Possibly take your description on the interface and put it here, with a short description on the interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind making this change and in fact I already have it in my tree, but I went to confirm that golint was happy and it seems it doesn't actually care about the plural form. Are there some options I need to use to get it to be strict about that?

$ golint
client.go:24:6: exported type HTTPConfig should have comment or be unexported
client.go:50:6: exported type UDPConfig should have comment or be unexported
client.go:60:6: exported type BatchPointsConfig should have comment or be unexported
client.go:91:1: comment on exported function NewHTTPClient should be of the form "NewHTTPClient ..."
client.go:321:6: exported type Point should have comment or be unexported
client.go:364:1: comment on exported method Point.Tags should be of the form "Tags ..."

Let me know if I should push my updated comments for consistency. I can also fix the other comments in a separate PR.

Thanks.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess my comment was meant more as "put the guts of the description on the method doc, and the shorter description on the interface field" 😄

And yes, we always appreciate some golint tidying!

@e-dard
Copy link
Contributor

e-dard commented Feb 10, 2016

LGTM 👍

@jwilder
Copy link
Contributor

jwilder commented Feb 10, 2016

@sparrc can you take a look?

@sparrc
Copy link
Contributor

sparrc commented Feb 10, 2016

LGTM 👍

jwilder added a commit that referenced this pull request Feb 10, 2016
@jwilder jwilder merged commit a51af5c into influxdata:master Feb 10, 2016
@jwilder
Copy link
Contributor

jwilder commented Feb 10, 2016

Thanks @PSUdaemon

@dneuman64
Copy link

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants