DOC: Updating str_slice docstring

[JesperDramsch]

Added Examples to docstring.
Added documentation to each part of docstring

[codecov]

Codecov Report

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

@@            Coverage Diff             @@
##           master   #22569      +/-   ##
==========================================
- Coverage   92.19%   92.18%   -0.01%     
==========================================
  Files         169      169              
  Lines       50833    50823      -10     
==========================================
- Hits        46863    46853      -10     
  Misses       3970     3970

Flag	Coverage Δ
#multiple	90.6% <ø> (ø)	⬆️
#single	42.36% <ø> (-0.01%)	⬇️

Impacted Files	Coverage Δ
pandas/core/strings.py	98.63% <ø> (ø)	⬆️
pandas/core/groupby/grouper.py	97.42% <0%> (-0.74%)	⬇️
pandas/core/internals/blocks.py	93.48% <0%> (-0.37%)	⬇️
pandas/core/dtypes/dtypes.py	95.85% <0%> (-0.26%)	⬇️
pandas/core/arrays/categorical.py	95.62% <0%> (-0.13%)	⬇️
pandas/io/pytables.py	92.44% <0%> (-0.05%)	⬇️
pandas/core/generic.py	96.65% <0%> (-0.02%)	⬇️
pandas/core/indexes/datetimelike.py	98.11% <0%> (ø)	⬆️
pandas/core/frame.py	97.2% <0%> (ø)	⬆️
pandas/core/indexes/multi.py	95.45% <0%> (ø)	⬆️
... and 13 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 6247da0...d49a2e7. Read the comment docs.

[gfyoung]

Nice changes!

cc @jreback @datapythonista

[datapythonista]

Nice changes, added some comments about formatting and ideas to make the docstring even better.

[jorisvandenbossche]

@JesperDramsch do you have time to update this PR based on the comments?

[JesperDramsch]

@JesperDramsch do you have time to update this PR based on the comments?

Totally missed this one. I'll get to it asap

[pep8speaks]

Hello @JesperDramsch! Thanks for updating the PR.

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

Comment last updated on October 03, 2018 at 21:27 Hours UTC

[JesperDramsch]

Here we go. Ran validation and updated everything according to the comments and linter. Thank you for the comments @datapythonista and thanks for the patience @jorisvandenbossche.

[datapythonista]

lgtm, thanks for another great docstring @JesperDramsch

The build is broken now, but will merge once it's fixed and the checks are green.

[datapythonista]

@JesperDramsch can you rebase, so the CI runs again, and we can merge it?

[JesperDramsch]

@JesperDramsch can you rebase, so the CI runs again, and we can merge it?

I'm not really sure what that means. How do I rebase?
Do you have a link?

[datapythonista]

Sorry, we use rebase as short for updating your PR with the latest master.

Just run in your branch: git fetch upstream && git merge upstream/master && git push.

This is usually required when the branch of the PR has conflicts with master. In this case github would manage the merge itself, as there are no conflicts. But as the checks of the CI failed (for reasons unrelated to your PR), we just want them to run again. And as there are many systems, and I don't thing I even have permissions to all them, the easiest is that you update your branch, and then all them are automatically rerun.

With some luck we'll make things easier soon. :)

[JesperDramsch]

Alright. I can get to that tomorrow easily.

[datapythonista]

@JesperDramsch seems like there is a formatting issue pandas/core/strings.py:1497:1: W293 blank line contains whitespace, that's why travis is failing.

Can you fix it please. Happy to merge it afterwards.

[JesperDramsch]

Aw Yiss.

[datapythonista]

Thanks for another great docstring @JesperDramsch