Added yard docs to circular buffer class. #506
Merged
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
tobyhs
reviewed
Dec 6, 2018
| @@ -2,30 +2,57 @@ module Bugsnag::Utility | |||
| class CircularBuffer | |||
| include Enumerable | |||
|
|
|||
| # @return [Numeric] the current maximum allowable number of items | |||
There was a problem hiding this comment.
This should be [Integer] instead of [Numeric]
| # | ||
| # If this causes the buffer to exceed its maximum items, the oldest item will be removed | ||
| # | ||
| # @param item [Any] the item to add to the buffer |
There was a problem hiding this comment.
This should probably be [Object] (although I could be wrong and wouldn't be surprised if I wasn't aware of some [Any] or [any] convention in yardoc)
| attr_reader :max_items | ||
|
|
||
| ## | ||
| # Creates a circular buffer |
There was a problem hiding this comment.
The main description portion of yard comments for #initialize is not needed as yard is smart enough to generate a generically useful one (but leave the @param comment in)
| ## | ||
| # Creates a circular buffer | ||
| # | ||
| # @api private |
There was a problem hiding this comment.
If users aren't exposed to the CircularBuffer in any direct way, move this @api private comment to the class (right before line 2). Also related, add a brief comment comment for the CircularBuffer class.
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.
Goal
Adds Yard doc comments to the circular buffer class.