DOC: Update the Series.str.len docstring #22187
Conversation
There was a problem hiding this comment.
Thanks for the PR @IsvenC, looks great. Just added some minor comments.
pandas/core/strings.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| lengths : Series/Index of integer values | ||
| Series or Index of integer values |
There was a problem hiding this comment.
We usually use Python types, Series or Index of int would be more consistent with the rest of the docstrings.
|
|
||
| See Also | ||
| -------- | ||
| str.len : Python built-in function returning the length of an object. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Good idea! Included in new commit.
pandas/core/strings.py
Outdated
|
|
||
| Examples | ||
| -------- | ||
|
|
There was a problem hiding this comment.
I don't think we need this blank line here
There was a problem hiding this comment.
You're right - I have taken it out
pandas/core/strings.py
Outdated
| -------- | ||
|
|
||
| Returning a series of integer values as floats when `NaN` is returned as a | ||
| result. |
There was a problem hiding this comment.
I think that's a useful comment, but not sure if very relevant in this context (the user checking the examples of the str.len). As this is a general pandas "problem", I'd simply omit it here. But if you think it's important in this page, the Notes section is probably a better place.
There was a problem hiding this comment.
Fair enough! A user can still see that the values are integers even if they happen to be floats.
pandas/core/strings.py
Outdated
| Returning the length (number of entries) of dictionaries, lists or | ||
| tuples as integer values. | ||
|
|
||
| >>> s = pd.Series([{'foo':'bar'}, [2,3,5,7], ('one', 'two', 'three')]) |
There was a problem hiding this comment.
missing spaces after colon and commas.
There was a problem hiding this comment.
Ah yes - thanks for spotting! Have changed in new commit.
pandas/core/strings.py
Outdated
| 0 1 | ||
| 1 4 | ||
| 2 3 | ||
| dtype: int64 |
There was a problem hiding this comment.
I would just create a single Series s with the elements of both examples. I think that would make the example more concise, and it'd still illustrate the same cases.
There was a problem hiding this comment.
Good point. Changed in new commit.
pandas/core/strings.py
Outdated
| Returning a series of integer values as floats when `NaN` is returned as a | ||
| result. | ||
|
|
||
| >>> s = pd.Series(['dog', 5, 'bird', np.nan]) |
There was a problem hiding this comment.
Very minor thing, but feels like if we're trying to confuse the user by not placing the two string values one after the other. And may be I'd show the empty string '' instead of one of the animals, that they are illustrating the same case.
There was a problem hiding this comment.
Have changed the structure of the consolidated example to incorporate an empty string.
Codecov Report
@@ Coverage Diff @@
## master #22187 +/- ##
=======================================
Coverage 92.06% 92.06%
=======================================
Files 169 169
Lines 50694 50694
=======================================
Hits 46671 46671
Misses 4023 4023
Continue to review full report at Codecov.
|
|
thanks @IsvenC |
[X] PR title is "DOC: update the docstring"
[X] The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
[X] The html version looks good: python doc/make.py --single