Show an example on top of CSV.read
#1004
Merged
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.
I was looking through the documentation of this package and noticed that there is no example for
CSV.read
. Instead it just lists all the arguments. I suggest to add a small example which answers:CSV
file as aDataFrame
?" since the majority of readers will be looking for thisCSV.read
function?"Maybe we can move the
CSV.read
also to the top of the page at https://csv.juliadata.org/stable/reading.html? That would make the information more consistent with the https://csv.juliadata.org/stable/writing.html. The writing page is excellent by the way. Very clear.