Add documentation to Array#pop #3675
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
dylandrop
commented
Dec 12, 2016
| # ``` | ||
| # a = [1] | ||
| # a.pop { "Testing" } #=> 1 | ||
| # a.pop { "Testing" } #=> "Testing" | ||
| def pop |
There was a problem hiding this comment.
Is this method even meant to be publicly exposed? It sure is an odd duck in terms of behavior. If it's meant to be private, perhaps it's best if it's hidden from the API docs altogether.
There was a problem hiding this comment.
Yes, it's public. Maybe you'd like to pop a value or use another default value instead of nil
asterite
reviewed
Dec 12, 2016
| @@ -1201,6 +1201,13 @@ class Array(T) | |||
| pop { raise IndexError.new } | |||
| end | |||
|
|
|||
| # Removes the last value from `self`. | |||
| # If the array is of size 0, the given block is called. | |||
There was a problem hiding this comment.
What about "If the array is empty"?
dylandrop
force-pushed
the
add-documentation-to-pop
branch
from
c7cc1cb
to
cd7ede3
Compare
|
@asterite Updated. |
|
Thanks! |
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.
Adds documentation to two undocumented variants of
Array#pop.