Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show an example on top of CSV.read #1004

Merged
merged 1 commit into from May 19, 2022
Merged

Conversation

rikhuijzer
Copy link
Contributor

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:

  1. "How do I open a CSV file as a DataFrame?" since the majority of readers will be looking for this
  2. "How do I pass one of these listed arguments to the CSV.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.

Copy link
Collaborator

@nickrobinson251 nickrobinson251 left a comment

Choose a reason for hiding this comment

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

Seems a good addition to me!

Copy link
Member

@quinnj quinnj left a comment

Choose a reason for hiding this comment

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

Thanks @rikhuijzer!

@quinnj quinnj merged commit 6073652 into JuliaData:main May 19, 2022
@rikhuijzer rikhuijzer deleted the rh/csv-read branch May 20, 2022 08:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants