Skip to content

DOC: Add documentation regarding no compression in to_parquet #19131

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 1 commit into from
Jan 8, 2018

Conversation

ylogx
Copy link
Contributor

@ylogx ylogx commented Jan 8, 2018

No description provided.

@ylogx ylogx force-pushed the feature/doc/parquet_doc branch from c618df8 to 1f6bc74 Compare January 8, 2018 08:52
@@ -1671,7 +1671,8 @@ def to_parquet(self, fname, engine='auto', compression='snappy',
'io.parquet.engine' is used. If 'auto', then the first
library to be installed is used.
compression : str, optional, default 'snappy'
compression method, includes {'gzip', 'snappy', 'brotli'}
Available compression methods are {'gzip', 'snappy', 'brotli'}
Copy link
Contributor

@TomAugspurger TomAugspurger Jan 8, 2018

Choose a reason for hiding this comment

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

Could you reformat this as

compression : {'snappy', 'gzip', 'brotli', None}
    Name of the compression to use. Use ``None`` for no compression

So that it follows https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt (section 4)

Same for down below.

@ylogx ylogx force-pushed the feature/doc/parquet_doc branch from 1f6bc74 to 5b65ed8 Compare January 8, 2018 12:39
@ylogx
Copy link
Contributor Author

ylogx commented Jan 8, 2018

@TomAugspurger 👍 Done.

@codecov
Copy link

codecov bot commented Jan 8, 2018

Codecov Report

Merging #19131 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #19131   +/-   ##
=======================================
  Coverage   91.53%   91.53%           
=======================================
  Files         148      148           
  Lines       48780    48780           
=======================================
  Hits        44651    44651           
  Misses       4129     4129
Flag Coverage Δ
#multiple 89.9% <ø> (ø) ⬆️
#single 41.59% <ø> (ø) ⬆️
Impacted Files Coverage Δ
pandas/core/frame.py 97.62% <ø> (ø) ⬆️
pandas/io/parquet.py 69.9% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6c0f8a...5b65ed8. Read the comment docs.

@TomAugspurger TomAugspurger added this to the 0.23.0 milestone Jan 8, 2018
@TomAugspurger TomAugspurger added Docs IO Parquet parquet, feather labels Jan 8, 2018
@TomAugspurger TomAugspurger merged commit 78147e9 into pandas-dev:master Jan 8, 2018
@TomAugspurger
Copy link
Contributor

Thanks @ylogx. Was there an issue for this?

@ylogx
Copy link
Contributor Author

ylogx commented Jan 9, 2018

@TomAugspurger Nope, I felt that this change could be discussed over the PR itself.

@ylogx ylogx deleted the feature/doc/parquet_doc branch January 9, 2018 04:35
maximveksler pushed a commit to maximveksler/pandas that referenced this pull request Jan 11, 2018
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.

2 participants