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: Add missing deprecation notice to str.concat #19324

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion crates/polars-core/src/series/implementations/string.rs
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ impl SeriesTrait for SeriesWrap<StringChunked> {
Err(polars_err!(
op = "`sum`",
DataType::String,
hint = "you may mean to call `str.concat` or `list.join`"
hint = "you may mean to call `str.join` or `list.join`"
))
}
fn max_reduce(&self) -> PolarsResult<Scalar> {
Expand Down
5 changes: 5 additions & 0 deletions py-polars/polars/expr/string.py
Original file line number Diff line number Diff line change
Expand Up @@ -2724,6 +2724,11 @@ def join(self, delimiter: str = "", *, ignore_nulls: bool = True) -> Expr:
"""
return wrap_expr(self._pyexpr.str_join(delimiter, ignore_nulls=ignore_nulls))

@deprecate_function(
"Use `str.join` instead. Note that the default `delimiter` for `str.join`"
" is an empty string instead of a hyphen.",
version="1.0.0",
)
def concat(
self, delimiter: str | None = None, *, ignore_nulls: bool = True
) -> Expr:
Expand Down
Loading