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(python): Fix docstring mistake for polars.concat_str #15937

Merged
merged 1 commit into from May 3, 2024

Conversation

wsyxbcl
Copy link
Contributor

@wsyxbcl wsyxbcl commented Apr 28, 2024

The default behavior of ignore_nulls in concat_str is incorrectly documented.

Not sure which default value is more intuitive, I simply corrected the documentation to avoid breaking changes. Though it differs from Series.list.concat or Series.string.concat, where the default value is True, introducing some inconsistency.

@github-actions github-actions bot added documentation Improvements or additions to documentation python Related to Python Polars labels Apr 28, 2024
@reswqa
Copy link
Collaborator

reswqa commented Apr 28, 2024

Though it differs from Series.list.concat or Series.string.concat, where the default value is True, introducing some inconsistency.

IIRC, this is because we don't want to make a breaking change before v1.0 when we introduce the ignore_nulls for concat_str.

@wsyxbcl
Copy link
Contributor Author

wsyxbcl commented Apr 29, 2024

Though it differs from Series.list.concat or Series.string.concat, where the default value is True, introducing some inconsistency.

IIRC, this is because we don't want to make a breaking change before v1.0 when we introduce the ignore_nulls for concat_str.

That's fine, we simply fix the doc then

@orlp orlp merged commit a87a8f3 into pola-rs:main May 3, 2024
12 of 15 checks passed
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 python Related to Python Polars
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants