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

DOC: Update param doc of to_parquet about compression #43004

Merged
merged 2 commits into from
Aug 17, 2021

Conversation

viirya
Copy link
Contributor

@viirya viirya commented Aug 12, 2021

Users are misled by current compression param doc. Actually more compressions like "ZSTD" are supported by pyarrow engine. This patch updates the param doc to reflect the supported compressions.

@jreback jreback added Docs IO Parquet parquet, feather labels Aug 13, 2021
@jreback jreback added this to the 1.4 milestone Aug 13, 2021
@@ -382,8 +382,11 @@ def to_parquet(
``io.parquet.engine`` is used. The default ``io.parquet.engine``
behavior is to try 'pyarrow', falling back to 'fastparquet' if
'pyarrow' is unavailable.
compression : {{'snappy', 'gzip', 'brotli', None}}, default 'snappy'
Name of the compression to use. Use ``None`` for no compression.
compression : {{'snappy', 'gzip', 'brotli', 'lz4', 'zstd', None}}, default 'snappy'
Copy link
Contributor

Choose a reason for hiding this comment

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

can you wrap the lines, this is too long

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sure. thanks.

@jreback jreback merged commit 87ee512 into pandas-dev:master Aug 17, 2021
@jreback
Copy link
Contributor

jreback commented Aug 17, 2021

thanks @viirya

@viirya
Copy link
Contributor Author

viirya commented Aug 17, 2021

Thanks @jreback @mroeschke

feefladder pushed a commit to feefladder/pandas that referenced this pull request Sep 7, 2021
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.

None yet

3 participants