DOC: Capitalize docstring summaries of Series

[avolkov]

Updated documentation to resolve SS02 errors in pandas.Series

• closes DOC: Capitalize docstring summaries of Series #23641
• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

[pep8speaks]

Hello @avolkov! Thanks for updating the PR.

• There are no PEP8 issues in the file pandas/core/arrays/sparse.py !

• There are no PEP8 issues in the file pandas/core/base.py !

• There are no PEP8 issues in the file pandas/core/generic.py !

• There are no PEP8 issues in the file pandas/core/indexes/base.py !

• There are no PEP8 issues in the file pandas/core/indexes/datetimelike.py !

• There are no PEP8 issues in the file pandas/core/series.py !

Comment last updated on November 20, 2018 at 16:35 Hours UTC

[datapythonista]

Nice work, thanks @avolkov

Do you mind taking care in this PR or the next issue in the same docstrings you fixed:

We have this in many cases:

def foo():
    """ Returns whatever is computed """

But the right formatting would be:

def foo():
    """
    Returns whatever is computed.
    """

Besides the capital letter:

• The summary should be in the next line than the initial """
• The first word, if a verb shouldn't be Returns (third-person) but Return the infinitive
• The Summary should finish with a period
  -The closing quotes go to the next line

Sorry I didn't see that was wrong in these same docstrings, but if you can fix this here, that would be really great.

[avolkov]

@datapythonista

Sure, I've noticed some of these strings were inconsistent.

I'll update current PR with fixes.

[datapythonista]

Thanks @avolkov much better now. I added few missing periods that you should be able to accept just with a click. Happy to merge after that.

[datapythonista]

Can you merge master into your branch @avolkov. Not sure why the CI was cancelled for this PR, but that should trigger a new run.

[datapythonista]

Still no luck with the CI, can you merge master again please

[avolkov]

I was sure something was wrong in master. If that doesn't work and re-run tests locally cherry-picking the changes.

[datapythonista]

@avolkov just realized that we have a test that it's checking the text in a docstring. That's what is making the CI fail. Can you take a look and fix it please?

This is what it's failing I think: pandas/tests/series/test_internals.py:320

    def test_hasnans_unchached_for_series():
        # GH#19700
        idx = pd.Index([0, 1])
        assert idx.hasnans is False
        assert 'hasnans' in idx._cache
        ser = idx.to_series()
        assert ser.hasnans is False
        assert not hasattr(ser, '_cache')
        ser.iloc[-1] = np.nan
        assert ser.hasnans is True
>       assert Series.hasnans.__doc__ == pd.Index.hasnans.__doc__
E       AssertionError: assert '\n        Re...ps.\n        ' == ' return if I ...erf speedups '
E         - 
E         -         Return if I have any nans; enables various perf speedups.
E         ?  ^^^^^^^^                                                       ^^
E         +  return if I have any nans; enables various perf speedups 
E         ?  ^                                                       ^
E         -

[datapythonista]

@avolkov can you fix the error in travis please:

./pandas/core/base.py:705:80: E501 line too long (80 > 79 characters)

[datapythonista]

Looks great, thank you @avolkov

[codecov]

Codecov Report

Merging #23647 into master will increase coverage by 0.03%.
The diff coverage is 66.66%.

@@            Coverage Diff             @@
##           master   #23647      +/-   ##
==========================================
+ Coverage   92.24%   92.28%   +0.03%     
==========================================
  Files         161      161              
  Lines       51339    51461     +122     
==========================================
+ Hits        47360    47493     +133     
+ Misses       3979     3968      -11

Flag	Coverage Δ
#multiple	90.68% <66.66%> (+0.04%)	⬆️
#single	42.31% <66.66%> (-0.04%)	⬇️

Impacted Files	Coverage Δ
pandas/core/indexes/datetimelike.py	97.74% <ø> (ø)	⬆️
pandas/core/series.py	93.68% <ø> (ø)	⬆️
pandas/core/arrays/sparse.py	91.94% <ø> (+0.12%)	⬆️
pandas/core/generic.py	96.84% <ø> (+0.01%)	⬆️
pandas/core/base.py	97.61% <100%> (ø)	⬆️
pandas/core/indexes/base.py	96.48% <50%> (+0.02%)	⬆️
pandas/core/arrays/datetimelike.py	95.96% <0%> (-0.19%)	⬇️
pandas/io/formats/format.py	97.76% <0%> (-0.13%)	⬇️
pandas/util/testing.py	86.04% <0%> (-0.04%)	⬇️
pandas/core/arrays/integer.py	95.47% <0%> (-0.02%)	⬇️
... and 42 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b4b945a...41a7ef5. Read the comment docs.

[jreback]

thanks!