Updated PeriodIndex docstrings #10094

[ExSidius]

• closes DOC: update docstrings with new Index repr #10094
• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

[pep8speaks]

Hello @ExSidius! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-04-17 00:52:02 UTC

[ExSidius]

I wasn't sure what to add in the whatsnew entry. Some guidance would be appreciated.

[codecov]

Codecov Report

Merging #26115 into master will decrease coverage by 51.25%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master   #26115       +/-   ##
===========================================
- Coverage   91.99%   40.74%   -51.26%     
===========================================
  Files         175      175               
  Lines       52384    52384               
===========================================
- Hits        48189    21342    -26847     
- Misses       4195    31042    +26847

Flag	Coverage Δ
#multiple	?
#single	40.74% <ø> (-0.13%)	⬇️

Impacted Files	Coverage Δ
pandas/core/arrays/period.py	43.65% <ø> (-54.88%)	⬇️
pandas/io/formats/latex.py	0% <0%> (-100%)	⬇️
pandas/io/sas/sas_constants.py	0% <0%> (-100%)	⬇️
pandas/core/groupby/categorical.py	0% <0%> (-100%)	⬇️
pandas/tseries/plotting.py	0% <0%> (-100%)	⬇️
pandas/tseries/converter.py	0% <0%> (-100%)	⬇️
pandas/io/formats/html.py	0% <0%> (-99.37%)	⬇️
pandas/io/sas/sas7bdat.py	0% <0%> (-91.16%)	⬇️
pandas/io/sas/sas_xport.py	0% <0%> (-90.1%)	⬇️
pandas/core/tools/numeric.py	10.44% <0%> (-89.56%)	⬇️
... and 131 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 68b1da7...f562dcd. Read the comment docs.

[codecov]

Codecov Report

Merging #26115 into master will decrease coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #26115      +/-   ##
==========================================
- Coverage   91.99%   91.98%   -0.01%     
==========================================
  Files         175      175              
  Lines       52384    52384              
==========================================
- Hits        48189    48184       -5     
- Misses       4195     4200       +5

Flag	Coverage Δ
#multiple	90.53% <ø> (ø)	⬆️
#single	40.74% <ø> (-0.13%)	⬇️

Impacted Files	Coverage Δ
pandas/core/arrays/period.py	98.53% <ø> (ø)	⬆️
pandas/io/gbq.py	75% <0%> (-12.5%)	⬇️
pandas/core/frame.py	96.9% <0%> (-0.12%)	⬇️
pandas/util/testing.py	90.61% <0%> (-0.11%)	⬇️

---

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 68b1da7...f562dcd. Read the comment docs.

[ExSidius]

Also unsure as to why code coverage issues are so significant.

[WillAyd]

These updates look good. No whatsnew is required for docstring updates.

Does this fully close the issue referenced? @jorisvandenbossche

[WillAyd]

Thanks @ExSidius

[ExSidius]

No problem.

[jorisvandenbossche]

Does this fully close the issue referenced? @jorisvandenbossche

From a quick search it seems it does. Thanks @ExSidius

[ExSidius]

Cheers. Happy to help.