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

docs: Make page about pandas null handling #1401

Open
MarcoGorelli opened this issue Nov 19, 2024 · 1 comment
Open

docs: Make page about pandas null handling #1401

MarcoGorelli opened this issue Nov 19, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@MarcoGorelli
Copy link
Member

MarcoGorelli commented Nov 19, 2024

We sometimes reference pandas and Polars handling null values differently in docs, but it's a bit scattered - I think we should:

  • only include it in the docstring if the function specifically modifies / counts/ drops null values (e.g. fill_null, null_count)
  • reference the page in those cases

I'm not sure we should be including Polars examples which includes 'nan' - the reason is that 'nan' is quite rare to encounter in Polars. Missing values are represented by null, and you'd only get 'nan' if you did something "illegal" like divide 0 by 0

My concern is that otherwise we distract from the main behaviour of the function in question

@MarcoGorelli MarcoGorelli added the documentation Improvements or additions to documentation label Nov 19, 2024
MarcoGorelli added a commit to DeaMariaLeon/narwhals that referenced this issue Nov 19, 2024
@MarcoGorelli MarcoGorelli mentioned this issue Nov 19, 2024
10 tasks
@MarcoGorelli
Copy link
Member Author

all_horizontal probably needs updating https://narwhals-dev.github.io/narwhals/api-reference/narwhals/#narwhals.all_horizontal, as it currently just says pandas and Polars handle null values differently.

and the example shows pandas with object dtype, whereas I think we should showcase boolean columns

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

1 participant