Skip to content

DOC: Minor addition to str.split #46027

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Feb 22, 2022
Merged

DOC: Minor addition to str.split #46027

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a457303
DOC: Minor addition to str.split
ChrisAlbertsen Feb 16, 2022
1a65748
Make Series uppercase and NaN plural
ChrisAlbertsen Feb 16, 2022
892988e
example suggestion for method behaviour
ChrisAlbertsen Feb 16, 2022
587c32a
allign Series values in hopes of passing tests
ChrisAlbertsen Feb 16, 2022
3afca25
fixed lowercase Nan typing error
ChrisAlbertsen Feb 17, 2022
45eaaa8
Merge branch 'main' into minor-docs-addition
ChrisAlbertsen Feb 19, 2022
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
13 changes: 12 additions & 1 deletion pandas/core/strings/accessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1880,6 +1880,7 @@ def encode(self, encoding, errors="strict"):

Strip whitespaces (including newlines) or a set of specified characters
from each string in the Series/Index from %(side)s.
Replaces any non-strings in Series with NaNs.
Equivalent to :meth:`str.%(method)s`.

Parameters
Expand All @@ -1901,40 +1902,50 @@ def encode(self, encoding, errors="strict"):

Examples
--------
>>> s = pd.Series(['1. Ant. ', '2. Bee!\n', '3. Cat?\t', np.nan])
>>> s = pd.Series(['1. Ant. ', '2. Bee!\n', '3. Cat?\t', np.nan, 10, True])
>>> s
0 1. Ant.
1 2. Bee!\n
2 3. Cat?\t
3 NaN
4 10
5 True
dtype: object

>>> s.str.strip()
0 1. Ant.
1 2. Bee!
2 3. Cat?
3 NaN
4 NaN
5 NaN
dtype: object

>>> s.str.lstrip('123.')
0 Ant.
1 Bee!\n
2 Cat?\t
3 NaN
4 NaN
5 NaN
dtype: object

>>> s.str.rstrip('.!? \n\t')
0 1. Ant
1 2. Bee
2 3. Cat
3 NaN
4 NaN
5 NaN
dtype: object

>>> s.str.strip('123.!? \n\t')
0 Ant
1 Bee
2 Cat
3 NaN
4 NaN
5 NaN
dtype: object
"""

Expand Down