Experimenting with recipes in CSV RDoc #175
Merged
Conversation
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
kou
reviewed
Sep 17, 2020
doc/csv/recipes.rdoc
Outdated
|
|
||
| Instance method CSV#read can read a file all at once: | ||
| string = "foo,0\nbar,1\nbaz,2\n" | ||
| CSV.new(string).read # => [["foo", "0"], ["bar", "1"], ["baz", "2"]] |
doc/csv/recipes.rdoc
Outdated
Comment on lines
123
to
124
| File.open(path, headers: true) do |file| | ||
| CSV.parse(file) |
Member
There was a problem hiding this comment.
Suggested change
| File.open(path, headers: true) do |file| | |
| CSV.parse(file) | |
| File.open(path) do |file| | |
| CSV.parse(file, headers: true) |
We also need to update output.
doc/csv/recipes.rdoc
Outdated
|
|
||
| in_string = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" | ||
| path = 't.csv' | ||
| File.open(path, 'w', headers: true) do |out_io| |
Member
There was a problem hiding this comment.
Suggested change
| File.open(path, 'w', headers: true) do |out_io| | |
| File.open(path, 'w') do |out_io| |
doc/csv/recipes.rdoc
Outdated
Comment on lines
278
to
279
| File.open(path) do |file| | ||
| CSV.filter(in_string, out_string) do |row| |
Member
There was a problem hiding this comment.
Suggested change
| File.open(path) do |file| | |
| CSV.filter(in_string, out_string) do |row| | |
| File.open(path) do |in_io| | |
| CSV.filter(in_io, out_string) do |row| |
Member
Author
|
Thanks, @kou. Did you like the idea of recipes? If so, there are many more possibilities. |
Member
|
Yes! I like this. |
esparta
reviewed
Sep 17, 2020
Contributor
esparta
left a comment
esparta
left a comment
There was a problem hiding this comment.
minimal typo & phrase suggestion
| ==== Parse from \String Without Headers | ||
|
|
||
| \Class method CSV.parse can read a source \String all at once, | ||
| and so may have memory resource implications: |
Contributor
There was a problem hiding this comment.
Suggested change
| and so may have memory resource implications: | |
| be aware this <procedure> may have memory resource implications: |
Not sure about adding procedure or something different.
Member
Author
There was a problem hiding this comment.
I'm leaving this as is. CSV.parse is the subject in both clauses, and so the sense, as I see it, is "CSV.parse may have memory resource implications."
Member
Author
|
@kou, this may be ready to merge. |
Member
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
New Recipes page is oriented to what the user wants to do (instead of what CSV can do). User finds in Contents the relevant task, follows link to get example working code.
Fulsome discussion welcome.