Skip to content
This repository has been archived by the owner on May 5, 2019. It is now read-only.

Update CSV examples to reflect that DataFrames is default CSV sink #50

Merged
merged 1 commit into from
Apr 17, 2017
Merged

Update CSV examples to reflect that DataFrames is default CSV sink #50

merged 1 commit into from
Apr 17, 2017

Conversation

cjprybol
Copy link
Contributor

@cjprybol cjprybol commented Apr 8, 2017

Current examples assume DataTable is the default sink. JuliaData/CSV.jl#73

```

and written using
note the second argument of `DataTable`, which instructs the CSV package to output a
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing initial uppercase.

@@ -159,14 +159,18 @@ using CSV
using DataTables, CSV
```

Datasets can now be read using
Datasets can now be read from input sources using
Copy link
Member

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.

```julia
CSV.read(...)
CSV.read(input, DataTable, args...)
Copy link
Member

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.

@cjprybol
Copy link
Contributor Author

Updated as suggested, thanks Milan!

```julia
CSV.read(...)
CSV.read(input, DataTable)
Copy link
Member

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.

Copy link
Contributor Author

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.
Copy link
Member

@nalimilan nalimilan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ararslan ararslan merged commit 46a4f3f into JuliaData:master Apr 17, 2017
@cjprybol cjprybol deleted the cjp/csv-man-update branch April 17, 2017 17:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants