polars icon indicating copy to clipboard operation
polars copied to clipboard

docs(python): Fix docstring mistake for polars.concat_str

Open wsyxbcl opened this issue 10 months ago • 2 comments

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.

wsyxbcl avatar Apr 28 '24 07:04 wsyxbcl

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.

reswqa avatar Apr 28 '24 09:04 reswqa

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

wsyxbcl avatar Apr 29 '24 02:04 wsyxbcl