Partial compliance with doc/method_documentation.rdoc #3431
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
jeremyevans
requested changes
Aug 19, 2020
array.c
Outdated
| @@ -4916,19 +4767,13 @@ rb_ary_zip(int argc, VALUE *argv, VALUE ary) | |||
| * | |||
| * Transposes the rows and columns in an array of arrays. | |||
| * | |||
| * Each element in +self+ must be an | |||
| * {Array-convertible object}[doc/implicit_conversion_rdoc.html#label-Array-Convertible+Objects]. | |||
| * Each element in +self+ must be an \Integer. | |||
There was a problem hiding this comment.
Shouldn't this be "must be an \Array"?
array.c
Outdated
| * - Argument +string_separator+, if given, myst be a | ||
| * {String-convertible object}[doc/implicit_conversion_rdoc.html#label-String-Convertible+Objects]. | ||
| * - Argument +n+, if given, must be an \Integer. | ||
| * - Argument +string_separator+, if given, myst be a \String. |
| * [] <=> CSV::Row.new([], []) # => 0 | ||
| * | ||
| * Returns +nil+ if +other_array+ is not an Array-convertible object: | ||
| * Returns +nil+ if +other_array+ is not an \Array. | ||
| * [] <=> 0 # => nil |
There was a problem hiding this comment.
We may want to delete this example, since it doesn't add new information.
There was a problem hiding this comment.
We shall delete this example, but later, in the course of eliminating low-information 1-line examples.
jeremyevans
approved these changes
Aug 19, 2020
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.
Removes references to *-convertible thingies. See https://github.com/ruby/ruby/blob/master/doc/method_documentation.rdoc#argument-description-if-necessary-
I've done these broadside (one issue in all methods) rather than method-wise (all issues in some methods) b/c it's both easier to make the mods and easier to review.
(But should have done this in two or three pieces. Better next time.)