Minor Rate, RateLimits documentation fixes. #276
Merged
+4
−4
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
Member
dmitshur
commented
Feb 11, 2016
dmitshur
commented
- Rate is now a method, not a field.
- Mention RateLimits rather than RateLimit since the latter is deprecated.
- Use Go convention for marking deprecated identifiers. See golang/blog@257114a.
| @@ -487,7 +487,7 @@ func (r RateLimits) String() string { | |||
| return Stringify(r) | |||
| } | |||
|
|
|||
| // RateLimit is deprecated. Use RateLimits instead. | |||
| // RateLimit is deprecated. Deprecated: Use RateLimits instead. | |||
There was a problem hiding this comment.
Maybe I could remove the first sentence altogether? I know golint would complain if it doesn't begin with "// RateLimit ...", but it's not very helpful.
https://godoc.org/image/jpeg#Reader does that, it just says "Deprecated: Reader is deprecated.".
There was a problem hiding this comment.
yeah, according to golang/blog@257114a it has to appear at the beginning of the paragraph.
There was a problem hiding this comment.
All right, I've updated it to be more like https://godoc.org/image/jpeg#Reader. It follows the second form as described in golang/go#10909 (comment):
2. long form 1, used with entities lacking docs // Deprecated: T is deprecated. type T struct { // Deprecated: for backward compatibility FieldC is still populated, // but new code should use FieldD instead. FieldC int32 FieldD int64 }
PTAL.
Rate is now a method, not a field. Mention RateLimits rather than RateLimit since the latter is deprecated. Use Go convention for marking deprecated identifiers. See golang/blog@257114a.
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.