Skip to content

DOC: Parquet IO docs don't match code #18285

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

Closed
mattayes opened this issue Nov 14, 2017 · 1 comment · Fixed by #18292
Closed

DOC: Parquet IO docs don't match code #18285

mattayes opened this issue Nov 14, 2017 · 1 comment · Fixed by #18292
Labels

Comments

@mattayes
Copy link
Contributor

mattayes commented Nov 14, 2017

Problem description

The Parquet section of the IO docs mentions the following caveat:

The format will NOT write an Index, or MultiIndex for the DataFrame and will raise an error if a non-default one is provided. You can simply .reset_index(drop=True) in order to store the index.

This conflicts with the error messages, which recommends:

you can .reset_index() to make the index into column(s)

Expected Output

AFAIK the error message is correct and the IO docs should remove drop=True:

The format will NOT write an Index, or MultiIndex for the DataFrame and will raise an error if a non-default one is provided. You can simply .reset_index() in order to store the index.

I'm happy to submit a PR for this.

@jorisvandenbossche
Copy link
Member

Yes, the drop=True indeed seems incorrect if the goal is to store the index (or you could mention both options: drop=True to ignore the index). PR very welcome!

@mattayes mattayes mentioned this issue Nov 14, 2017
4 tasks
TomAugspurger pushed a commit to TomAugspurger/pandas that referenced this issue Dec 8, 2017
TomAugspurger pushed a commit that referenced this issue Dec 11, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants