make Period field public on Rate struct #35
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
brandur
added a commit
that referenced
this pull request
Mar 13, 2018
As #35 was coming in, I noticed that as of Go 1.10, `go vet` complains about the use of unkeyed fields in composite literals: ``` go vet ./... ./example_test.go:26: github.com/throttled/throttled.RateQuota composite literal uses unkeyed fields ./example_test.go:51: github.com/throttled/throttled.RateQuota composite literal uses unkeyed fields ./http_test.go:19: github.com/throttled/throttled.RateLimitResult composite literal uses unkeyed fields ./http_test.go:23: github.com/throttled/throttled.RateLimitResult composite literal uses unkeyed fields ./rate_test.go:41: github.com/throttled/throttled.RateQuota composite literal uses unkeyed fields ./rate_test.go:114: github.com/throttled/throttled.RateQuota composite literal uses unkeyed fields ``` Which is unfortunately failing the build for the `1.x` version. This patch names fields wherever we were using the unkeyed kind.
brandur
reviewed
Mar 13, 2018
rate.go
Outdated
| @@ -78,7 +78,7 @@ func (r *rateLimitResult) RetryAfter() time.Duration { return r.retryAfter } | |||
| // Rate describes a frequency of an activity such as the number of requests | |||
| // allowed per minute. | |||
| type Rate struct { | |||
| period time.Duration // Time between equally spaced requests at the rate | |||
| Period time.Duration // Time between equally spaced requests at the rate | |||
There was a problem hiding this comment.
Now that this is a public field, could you move the comment up to appear above it and change it to follow go convention to read something like "Period is the amount of time between equally spaced requests for this rate."
There was a problem hiding this comment.
Oh, thanks, I didn't realize side comments were treated differently.
There was a problem hiding this comment.
I'm not sure they are, but the important part is to have the documentation start with the field name (i.e., "Period ...") because that's a Go convention for public field documentation that Golint will complain about if not followed. (Moving the comment above just gives us a little more space.)
this can be useful for custom implementations of RateLimiter that need to reflect on the configured period for calculations. one example is github.com/keratin/throttled-valve.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Period field can can be useful for third-party implementations of RateLimiter that need to reflect on the configured period for calculations. One example is described in #34.