Skip to content

Commit

Permalink
docs(python): Add missing deprecation entry for str.concat, API ref…
Browse files Browse the repository at this point in the history
… entry for `str.join`, build docs on pre-release (pola-rs#16913)
  • Loading branch information
stinodego authored Jun 12, 2024
1 parent b902601 commit 6711d4c
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ jobs:
target-folder: api/python/dev
single-commit: true

- name: Parse the tag to find the major/minor version of Polars
- name: Parse the tag to find the major version of Polars
id: version
if: github.event_name == 'repository_dispatch'
shell: bash
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -270,7 +270,7 @@ jobs:
TAG: ${{ steps.github-release.outputs.tag_name }}

- name: Trigger other workflows related to the release
if: inputs.dry-run == false && steps.version.outputs.is_prerelease == 'false'
if: inputs.dry-run == false
uses: peter-evans/repository-dispatch@v3
with:
event-type: python-release
Expand Down
1 change: 1 addition & 0 deletions py-polars/docs/source/reference/expressions/string.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The following methods are available under the `expr.str` attribute.
Expr.str.extract_groups
Expr.str.find
Expr.str.head
Expr.str.join
Expr.str.json_decode
Expr.str.json_path_match
Expr.str.len_bytes
Expand Down
1 change: 1 addition & 0 deletions py-polars/docs/source/reference/series/string.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ The following methods are available under the `Series.str` attribute.
Series.str.extract_groups
Series.str.find
Series.str.head
Series.str.join
Series.str.json_decode
Series.str.json_path_match
Series.str.len_bytes
Expand Down
4 changes: 4 additions & 0 deletions py-polars/polars/expr/string.py
Original file line number Diff line number Diff line change
Expand Up @@ -2562,6 +2562,10 @@ def concat(
"""
Vertically concatenate the string values in the column to a single string value.
.. deprecated:: 1.0.0
Use :meth:`join` instead. Note that the default `delimiter` for :meth:`join`
is an empty string instead of a hyphen.
Parameters
----------
delimiter
Expand Down
4 changes: 4 additions & 0 deletions py-polars/polars/series/string.py
Original file line number Diff line number Diff line change
Expand Up @@ -1926,6 +1926,10 @@ def concat(
"""
Vertically concatenate the string values in the column to a single string value.
.. deprecated:: 1.0.0
Use :meth:`join` instead. Note that the default `delimiter` for :meth:`join`
is an empty string instead of a hyphen.
Parameters
----------
delimiter
Expand Down

0 comments on commit 6711d4c

Please sign in to comment.