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

The pivot user guide doc and API doc are both outdated #17415

Closed
liufeimath opened this issue Jul 4, 2024 · 4 comments
Closed

The pivot user guide doc and API doc are both outdated #17415

liufeimath opened this issue Jul 4, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@liufeimath
Copy link
Contributor

Description

The following are outdated:
https://docs.pola.rs/user-guide/transformations/pivot/
https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.pivot.html

There is no on anymore (now: columns).

It looks like Polars API documentation structure doesn't follow the DRY principle? I indeed learned this principle formally for the first time in your doc ^_^!

Link

https://docs.pola.rs/api/python/stable/reference/dataframe/api/polars.DataFrame.pivot.html

@liufeimath liufeimath added the documentation Improvements or additions to documentation label Jul 4, 2024
@etiennebacher
Copy link
Contributor

etiennebacher commented Jul 4, 2024

The columns parameter of pivot was renamed on in #17095 (see https://github.com/pola-rs/polars/pull/17095/files#diff-50f8a5e1ee71cadef61bbae257a72d6b4549020e76abe947b4ee36ef79d553c6 for the specific change in pivot), so the user guide and API docs are correct.

@MarcoGorelli
Copy link
Collaborator

hi @liufeimath - could you clarify which part is outdated please? looks fine to me but I might have missed something

@stinodego
Copy link
Member

stinodego commented Jul 4, 2024

Thanks for the report, but it seems like you were looking at an old (cached?) version of the docs somehow.

I'll close this - can reopen if you can show us some steps to get to an outdated version of the docs.

@stinodego stinodego closed this as not planned Won't fix, can't repro, duplicate, stale Jul 4, 2024
@liufeimath
Copy link
Contributor Author

Oh got it. I was using an 0.20.x version before and didn't realize that columns was renamed to on in 1.0.0. All good now. Thanks!

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

4 participants