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

Documentation for polars.Expr.is_in / polars.Expr.ise seems broken. #21539

Open
z3rone opened this issue Feb 28, 2025 · 13 comments
Open

Documentation for polars.Expr.is_in / polars.Expr.ise seems broken. #21539

z3rone opened this issue Feb 28, 2025 · 13 comments
Labels
bug Something isn't working documentation Improvements or additions to documentation P-medium Priority: medium

Comments

@z3rone
Copy link

z3rone commented Feb 28, 2025

Description

I am currently using python polars 1.23.0 and it seems to me that the documented expression polars.Expr.ise() should be in fact polars.Expr.is_in. Going to the docs for 0.20 there is even a redirection issue with the expression, switching betwen ise and is_in constantly (see https://docs.pola.rs/api/python/version/0.20/reference/expressions/api/polars.Expr.is_in.html in Firefox 135.0)

Link

No response

@z3rone z3rone added the documentation Improvements or additions to documentation label Feb 28, 2025
@deanm0000
Copy link
Collaborator

deanm0000 commented Feb 28, 2025

Looks like this is for the whole site when trying to select a version before stable, not just is_in. I put this as medium since it's outward facing but didn't go higher since it's for deprecated versions.

@deanm0000 deanm0000 added bug Something isn't working P-medium Priority: medium labels Feb 28, 2025
@mcrumiller
Copy link
Contributor

Can confirm, trying to select anything <= 0.20 creates the issue.

@z3rone
Copy link
Author

z3rone commented Feb 28, 2025

The main issue is that polars.Expr.ise() does not seem to exist (in any version) and actually should be polars.Expr.is_in(). However ,polars.Expr.is_in() is not documented anywhere in the latest version, even though I can confirm it very much exists in 1.23.0.

@deanm0000
Copy link
Collaborator

It's not just that method. I can't say it's for absolutely all the methods but for the handful of the ones I tried, it did the same behavior. tbh, I'm not sure what polars.Expr.ise() is or came from. Neither of the links in your post have "ise" in them. They both are "is_in".

@mcrumiller
Copy link
Contributor

mcrumiller commented Feb 28, 2025

polars.Expr.is_in() is not documented anywhere in the latest version

It's right here: https://docs.pola.rs/api/python/stable/reference/expressions/api/polars.Expr.is_in.html

You can also navigate to it via Expressions -> Boolean:

Image

@mcrumiller
Copy link
Contributor

mcrumiller commented Feb 28, 2025

I'm confused too, I've never heard of ise. What is that, and can you provide a link to it?

@z3rone
Copy link
Author

z3rone commented Feb 28, 2025

when you click on the link you provided the actual page shows ise instead of is_in

@mcrumiller
Copy link
Contributor

Where? I think something may be wrong with your browser.

Image

@z3rone
Copy link
Author

z3rone commented Feb 28, 2025

you might be right. It only occurs in FF. Chrome and Safari are fine...
Image

@z3rone
Copy link
Author

z3rone commented Feb 28, 2025

disabling ublock did not help neither did updating to FF 135.0.1 (aarch64)

@mcrumiller
Copy link
Contributor

mcrumiller commented Feb 28, 2025

I just installed Firefox and I cannot reproduce.

There is nothing in the codebase that has ise as a function, expression, or any time of variable. When I search py-polars/docs/source/** for the regular expression ise\s*$ it only matches the word Bitwise. I honestly have no idea what's going. Is it possible that you have some weird extension in your browser that replaces _in with e? Or maybe it's replacing s_in with se?

Can you right click and do whatever Firefox version's of View Source is, and see if the Expr.ise is actually in the html? This is incredibly weird.

@z3rone
Copy link
Author

z3rone commented Feb 28, 2025

oh god I found the issue. It was an experimental plugin. Sorry for the trouble.

@z3rone z3rone closed this as completed Feb 28, 2025
@deanm0000
Copy link
Collaborator

deanm0000 commented Mar 1, 2025

The reloading loop still remains so I'm reopening

@deanm0000 deanm0000 reopened this Mar 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation P-medium Priority: medium
Projects
None yet
Development

No branches or pull requests

3 participants