Skip to content

DOC: update the Series.str.join docstring #22174

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 8 commits into from
Aug 8, 2018
Merged

DOC: update the Series.str.join docstring #22174

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ea35874
Clarify return value for str.join
feiphoon Aug 2, 2018
5920d15
Correction for PEP8 style
feiphoon Aug 2, 2018
33bf98a
Fix validation error with list indices
feiphoon Aug 2, 2018
639c090
Update notes accordingly
feiphoon Aug 2, 2018
b78a24a
Reinstate the previous example - missing comma
feiphoon Aug 2, 2018
68308cb
Correct indentation
feiphoon Aug 2, 2018
35d50e4
Reinstate sentence, with language improvements
feiphoon Aug 2, 2018
e03704d
Move item from Notes to Raises
feiphoon Aug 7, 2018
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
16 changes: 11 additions & 5 deletions pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1105,10 +1105,17 @@ def str_join(arr, sep):
Returns
-------
Series/Index: object
The list entries concatenated by intervening occurrences of the
delimiter.

Raises
-------
AttributeError
If the supplied Series contains neither strings nor lists.

Notes
-----
If any of the lists does not contain string objects the result of the join
If any of the list items is not a string object, the result of the join
will be `NaN`.

See Also
Expand All @@ -1118,13 +1125,12 @@ def str_join(arr, sep):

Examples
--------

Example with a list that contains non-string elements.

>>> s = pd.Series([['lion', 'elephant', 'zebra'],
... [1.1, 2.2, 3.3],
... ['cat', np.nan, 'dog'],
... ['cow', 4.5, 'goat']
... ['cow', 4.5, 'goat'],
... ['duck', ['swan', 'fish'], 'guppy']])
>>> s
0 [lion, elephant, zebra]
Expand All @@ -1134,8 +1140,8 @@ def str_join(arr, sep):
4 [duck, [swan, fish], guppy]
dtype: object

Join all lists using an '-', the lists containing object(s) of types other
than str will become a NaN.
Join all lists using a '-'. The lists containing object(s) of types other
than str will produce a NaN.

>>> s.str.join('-')
0 lion-elephant-zebra
Expand Down