Skip to content

DOC: Update doc of parquet compression parameter #51554

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

Merged
merged 4 commits into from
Feb 25, 2023

Conversation

ChristofKaufmann
Copy link
Contributor

This commit updates the interface documentation of pandas.DataFrame.to_parquet. The documentation of the parameter compression is not up-to-date compared to the implementation documentation of pandas.io.parquet.to_parquet. This commit copies the documentation of the implementation to the interface.

@ChristofKaufmann ChristofKaufmann changed the title Update documentation of parquet compression parameter DOC: Update doc of parquet compression parameter Feb 22, 2023
@simonjayhawkins simonjayhawkins added Docs IO Parquet parquet, feather labels Feb 22, 2023
@mroeschke
Copy link
Member

Could you merge in the main branch? Appears to be a linting error as well.

@ChristofKaufmann
Copy link
Contributor Author

Yes, now it has. It says "pandas/core/frame.py:2804:89: E501 Line too long (91 > 88 characters)". It refers to the line, where you requested to add the default value to get a consistent style. However, this is why the first line of this parameter description exceeds the maximum line width.

  • We could move the default value back to the second line.
  • We could replace the list of possible values by str or None, default 'snappy'. The text still describes possible values.
  • We could ignore the failing check or somehow add an expected failure.
  • You could extend the allowed line width.

What do you think is the best fix?

@mroeschke
Copy link
Member

We could replace the list of possible values by str or None, default 'snappy'. The text still describes possible values.

This option sounds best

@ChristofKaufmann
Copy link
Contributor Author

Should be fine now.

@phofl phofl added this to the 2.1 milestone Feb 25, 2023
@phofl phofl merged commit a80ffdb into pandas-dev:main Feb 25, 2023
@phofl
Copy link
Member

phofl commented Feb 25, 2023

thx @ChristofKaufmann

@ChristofKaufmann ChristofKaufmann deleted the doc-parquet-compression branch February 26, 2023 06:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO Parquet parquet, feather
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants