Adds RDoc summary of Hash methods #4045
Conversation
BurdetteLamar
changed the title
| * | ||
| * ==== Methods for Fetching | ||
| * | ||
| * #[]:: Returns the value associated with a given key. |
There was a problem hiding this comment.
Mention it returns the default value if the key isn't present, similar with values_at.
There was a problem hiding this comment.
I'd like to keep these 1-liners simple, and not indicate exceptional behavior.
| * #[]:: Returns the value associated with a given key. | ||
| * #assoc:: Returns a 2-element array containing a given key and its value. | ||
| * #dig:: Returns the object in nested objects that is specified by a given key and identifiers. | ||
| * #fetch:: Returns the value for a given key. |
There was a problem hiding this comment.
Mention it raises a KeyError if the key is not present, similar with fetch_values.
There was a problem hiding this comment.
I'd like to keep these 1-liners simple, and not indicate exceptional behavior.
hash.c
Outdated
| * #filter!:: Removes entries selected by a given block. | ||
| * #keep_if:: Removes entries selected by a given block. | ||
| * #reject!:: Removes entries selected by a given block. | ||
| * #select!:: Removes entries selected by a given block. |
There was a problem hiding this comment.
Please use different text for methods that aren't aliases. For #filter, #keep_if, #select, I would use "Removes entries not selected by a given block" or "Only keep entries selected by a given block".
There was a problem hiding this comment.
Done, I think, but please re-review.
hash.c
Outdated
| * #keep_if:: Keep only those entries selected by a given block. | ||
| * #reject!:: Removes entries selected by a given block. | ||
| * #shift:: Removes and returns the first entry. | ||
| * #slice:: Returns a hash containing the entries for given keys. |
There was a problem hiding this comment.
#slice returns a copy of self, it doesn't modify self, so it should be moved to the section below.
| * #compact:: Returns a copy of +self+ with all +nil+-valued entries removed. | ||
| * #except:: Returns a copy of +self+ with entries removed for specified keys. | ||
| * #filter, #select:: Returns a copy of +self+ with entries removed as specified by a given block. | ||
| * #reject:: Returns a copy of +self+ with entries removed as specified by a given block. |
There was a problem hiding this comment.
#filter/#select and #reject have the opposite behavior, you need to use different text for them. You could change removed to kept (or removed except) for #filter/#select to fix this.
There was a problem hiding this comment.
#filter/#select now similar to #filter!/#select! above:
- #filter, #select:: Returns a copy of +self+ with only those entries selected by a given block.
Adds a linked summary of methods by category.