Skip to content

DOC: Update the Series.str.len docstring #22187

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

DOC: Update the Series.str.len docstring #22187

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
089700b
Update docstring for Series.str.len
IsvenC Aug 3, 2018
b72edec
Style changes to conform with PEP-8
IsvenC Aug 3, 2018
05ec61a
Add See Also, consolidate examples, improve syntax
IsvenC Aug 6, 2018
218f6fe
Improve readability
IsvenC Aug 6, 2018
f395314
Change series definition structure
IsvenC Aug 6, 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
41 changes: 39 additions & 2 deletions pandas/core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2801,11 +2801,48 @@ def rindex(self, sub, start=0, end=None):
return self._wrap_result(result)

_shared_docs['len'] = ("""
Compute length of each string in the Series/Index.
Computes the length of each element in the Series/Index. The element may be
a sequence (such as a string, tuple or list) or a collection
(such as a dictionary).

Returns
-------
lengths : Series/Index of integer values
Series or Index of int
A Series or Index of integer values indicating the length of each
element in the Series or Index.

See Also
--------
str.len : Python built-in function returning the length of an object.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about adding Series.size here? I think some users could come by mistake to this page looking how to check the length of the Series. And it'd be nice to help them find it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea! Included in new commit.

Series.size : Returns the length of the Series.

Examples
--------
Returns the length (number of characters) in a string. Returns the
number of entries for dictionaries, lists or tuples.

>>> s = pd.Series(['dog',
... '',
... 5,
... {'foo' : 'bar'},
... [2, 3, 5, 7],
... ('one', 'two', 'three')])
>>> s
0 dog
1
2 5
3 {'foo': 'bar'}
4 [2, 3, 5, 7]
5 (one, two, three)
dtype: object
>>> s.str.len()
0 3.0
1 0.0
2 NaN
3 1.0
4 4.0
5 3.0
dtype: float64
""")
len = _noarg_wrapper(len, docstring=_shared_docs['len'], dtype=int)

Expand Down