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

compat_level documentation is unclear #18210

Open
etiennebacher opened this issue Aug 15, 2024 · 1 comment
Open

compat_level documentation is unclear #18210

etiennebacher opened this issue Aug 15, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@etiennebacher
Copy link
Contributor

Description

#17421 replaced the future parameter by compat_level, but it is not clear from the docs (for example for write_ipc()) what this accepts and what the meaning of each value is.

Before (https://docs.pola.rs/api/python/version/0.20/reference/api/polars.DataFrame.write_ipc.html#polars.DataFrame.write_ipc):

future
Setting this to True will write Polars’ internal data structures that might not be available by other Arrow implementations.

After (https://docs.pola.rs/api/python/dev/reference/api/polars.DataFrame.write_ipc.html)

compat_level
Use a specific compatibility level when exporting Polars’ internal data structures.

The PR linked above added some docs for CompatLevel but those are not displayed on the website (the only matches are for the parameter type): https://docs.pola.rs/api/python/dev/search.html?q=CompatLevel#

Link

No response

@etiennebacher etiennebacher added the documentation Improvements or additions to documentation label Aug 15, 2024
@redfave
Copy link

redfave commented Jan 3, 2025

I stumbled also across this and haven't found anything in the docs regarding the allowed values and consequences of behaviour. It would be nice to have this documented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants