docs: add writer properties to docs #2002
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ion-elgreco
requested review from
MrPowers,
wjones127,
fvaleye and
roeap
as code owners
MrPowers
reviewed
Dec 30, 2023
| """ | ||
| !!! warning "Deprecated" | ||
| Use `.merge(writer_properties = WriterProperties())` instead | ||
| Pass writer properties to the Rust parquet writer, see options https://arrow.apache.org/rust/parquet/file/properties/struct.WriterProperties.html: |
There was a problem hiding this comment.
Can we use something other than "Rust Parquet writer" for the Python API docs?
I would rather link to our docs than a third party page? Can we add a "Python version" of all these options to the documentation?
There was a problem hiding this comment.
There is a short description of each argument, I only kept the rust docs link in there in case people want to request more properties to be exposed.
There was a problem hiding this comment.
@MrPowers what shall we do? Would be good to merge this since the new release contains the WriterProperties but the docs not yet if we don't merge this : P
There was a problem hiding this comment.
@ion-elgreco - merge away! We can always improve the docs later!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Forgot to add WriterProperties to the docs page and mark a deprecation in the docs.