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

ARROW-6630: [Doc] Document C++ file formats #5500

Closed
wants to merge 1 commit into from

Conversation

pitrou
Copy link
Member

@pitrou pitrou commented Sep 25, 2019

No description provided.

@pitrou pitrou force-pushed the ARROW-6630-file-format-docs branch from 3c6b044 to f864965 Compare September 25, 2019 12:31

=================
Reading CSV files
=================
Copy link
Member Author

Choose a reason for hiding this comment

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

@nealrichardson Could you take a quick look at this file and see if it makes things easy to understand?

@pitrou pitrou force-pushed the ARROW-6630-file-format-docs branch from f864965 to 1fdc5b0 Compare September 25, 2019 12:47
Copy link
Member

@nealrichardson nealrichardson left a comment

Choose a reason for hiding this comment

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

Definitely an improvement. Just a few questions. As with the last doc patch, even though there's more to be done here (JSON, Parquet, etc.), IMO this is worth merging whenever and we can continue to iterate on the docs.

docs/source/cpp/csv.rst Outdated Show resolved Hide resolved
docs/source/cpp/csv.rst Outdated Show resolved Hide resolved
docs/source/cpp/csv.rst Outdated Show resolved Hide resolved
Null values are recognized from the spellings stored in
:member:`ConvertOptions::null_values`. The :func:`ConvertOptions::Defaults`
factory method will initialize a number of conventional null spellings such
as ``N/A``.
Copy link
Member

Choose a reason for hiding this comment

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

It might be good to list them all since this is reference documentation.

@pitrou pitrou force-pushed the ARROW-6630-file-format-docs branch from 1fdc5b0 to aa5c57d Compare September 25, 2019 15:18
@pitrou pitrou changed the title [WIP] ARROW-6630: [Doc] Document C++ file formats ARROW-6630: [Doc] Document C++ file formats Sep 25, 2019
@pitrou
Copy link
Member Author

pitrou commented Sep 25, 2019

Ok, I've also added some docs for JSON and (very incomplete) Parquet. I think this can be merged once CI is green.


=================================
Reading and writing Parquet files
=================================
Copy link
Member Author

Choose a reason for hiding this comment

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

@wesm If you want to quickly check that this stub doesn't say anything silly :-)

@pitrou
Copy link
Member Author

pitrou commented Sep 25, 2019

@pitrou pitrou closed this in 196face Sep 25, 2019
@pitrou pitrou deleted the ARROW-6630-file-format-docs branch September 25, 2019 16:32
alippai pushed a commit to alippai/arrow that referenced this pull request Sep 26, 2019
Closes apache#5500 from pitrou/ARROW-6630-file-format-docs and squashes the following commits:

aa5c57d <Antoine Pitrou> ARROW-6630:  Document C++ file formats

Authored-by: Antoine Pitrou <[email protected]>
Signed-off-by: Antoine Pitrou <[email protected]>
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.

2 participants