Enhanced RDoc for several methods#158
Merged
kou merged 2 commits intoruby:masterfrom Jul 20, 2020
BurdetteLamar:rdoc
Merged
Conversation
kou
reviewed
Jul 19, 2020
|
|
||
| # :call-seq: | ||
| # read | ||
| # csv.read -> array or csv_table |
Member
There was a problem hiding this comment.
How about splitting each pattern?
Suggested change
| # csv.read -> array or csv_table | |
| # csv.read -> array | |
| # csv.read -> csv_table (CSV::Table is better?) |
Member
Author
There was a problem hiding this comment.
What I have here is what I see in the doc for such as Hash and Array. People have been careful to use something (csv_table) that is English, not code. I once wrote foo.to_h -> Hash, and had someone point out that it's somewhat ambiguous: class Hash or instance of Hash?
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Methods: