-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: fix shared compression_options and decompression_options #47609
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
Conversation
Both compression_options and decompression_options made the same reference to zstandard.ZstdDecompressor however compression uses zstandard.ZstdCompressor and so the documentation for compression_options should refer to this class instead
The shared doc strings compression_options and decompression_options require an interpolated string for the name of the parameter that takes a filepath/buffer, with the name of this parameter. It was missing in a few places. Also fix a small gramatical error in compression_options
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you build the docs and show an example?
original https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.to_csv.html:
original https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html:
Decompression for original https://pandas.pydata.org/docs/reference/api/pandas.read_stata.html:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thx, lgtm
Thanks @alastair |
…-dev#47609) * DOC: Fix reference to ZstdCompressor in compression_options Both compression_options and decompression_options made the same reference to zstandard.ZstdDecompressor however compression uses zstandard.ZstdCompressor and so the documentation for compression_options should refer to this class instead * DOC: Fix string interpolation in compression/decompression_options The shared doc strings compression_options and decompression_options require an interpolated string for the name of the parameter that takes a filepath/buffer, with the name of this parameter. It was missing in a few places. Also fix a small gramatical error in compression_options
Both compression_options and decompression_options made the same
reference to zstandard.ZstdDecompressor however compression uses
zstandard.ZstdCompressor and so the documentation for
compression_options should refer to this class instead
The shared doc strings compression_options and decompression_options
require an interpolated string for the name of the parameter that takes
a filepath/buffer, with the name of this parameter.
It was missing in a few places.
Also fix a small gramatical error in compression_options
It took me a while to find the documentation for the python zstandard library to see what options are available to pass in as a dictionary, do you think it's worth updating the text
zstandard.ZstdDecompressor
in the docs to be a link to https://python-zstandard.readthedocs.io/en/latest/decompressor.html?I saw some test failures when running test_fast.sh inside the provided Docker image, but from what I can tell, these are not related to the changes that I made, and I also see the same failure when running tests from
main
:test failure
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.