-
Notifications
You must be signed in to change notification settings - Fork 11
Update CSV examples to reflect that DataFrames is default CSV sink #50
Conversation
docs/src/man/getting_started.md
Outdated
``` | ||
|
||
and written using | ||
note the second argument of `DataTable`, which instructs the CSV package to output a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing initial uppercase.
docs/src/man/getting_started.md
Outdated
@@ -159,14 +159,18 @@ using CSV | |||
using DataTables, CSV | |||
``` | |||
|
|||
Datasets can now be read using | |||
Datasets can now be read from input sources using |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"input sources" is quite vague. Since this section talks about files, better say "files" instead to keep things simple. Reading from streams is a more advanced use case, which could be mentioned as a bonus.
docs/src/man/getting_started.md
Outdated
```julia | ||
CSV.read(...) | ||
CSV.read(input, DataTable, args...) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
args
isn't defined. I would just put the two first arguments, and say in the text that more optional arguments can be passed.
Updated as suggested, thanks Milan! |
docs/src/man/getting_started.md
Outdated
```julia | ||
CSV.read(...) | ||
CSV.read(input, DataTable) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
input
is still not defined. I would add something to the previous paragraph, like "A dataset can now be read from a CSV file at path input
using". Same for output
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updates made
Current examples assume DataTable is the default sink.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Current examples assume DataTable is the default sink. JuliaData/CSV.jl#73