DOC: Fix format of the See Also descriptions

[syutbai]

• does not close, but partially contributes to DOC: Fix format of the See Also descriptions #23630
• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff
• whatsnew entry

[TomAugspurger]

Hmm @gueletk also has the "See Also" changes in #23653

@syutbai would it be hard for you to revert those changes, so that there isn't a merge conflict?

[datapythonista]

Thanks a lot for working on this @syutbai, looks great.

I'm not sure if git will be able to merge automatically the changes to the titles, as they are the same exact change. I'd wait until we have the conflict, in case it's not needed.

[datapythonista]

Looks like git manages the merge ok.

@syutbai can you fix the linting errors on travis, so we can merge:

./pandas/core/frame.py:354:5: W191 indentation contains tabs
./pandas/core/frame.py:354:5: E101 indentation contains mixed spaces and tabs
./pandas/core/frame.py:1923:80: E501 line too long (80 > 79 characters)

[syutbai]

@datapythonista Sorry for the tabbing issues. I pushed the changes to my branch. Do I need to do another pull request or are we good for merge now? Thanks!

[datapythonista]

Updating the branch is good enough, no need to open a new PR.

I see travis is still red, can you take a look and see what is wrong? I'm in my phone and can't check myself right now.

[syutbai]

I see the following error but the script ends with 0:

3 Errors found:
	err desc
	err desc
	err desc
.docstring1: err desc
docstring1: err desc
docstring1: err desc
docstring2: err desc
docstring2: err desc
..EXECUTED
{"docstring1": {"errors": [["ER01", "err desc"], ["ER02", "err desc"], ["ER03", "err desc"]]}, "docstring2": {"errors": [["ER04", "err desc"], ["ER05", "err desc"]]}}.Series.foo: err desc
DataFrame.bar: err desc
Series.foobar: err desc
Series.foo: err desc

=============== 75 passed, 4 xfailed, 5 warnings in 3.48 seconds ===============
The command "ci/script_single.sh" exited with 0.

The other script ends with exit code 1 but I'm unable to tell where the error is:

=================== 5 passed, 12 deselected in 0.04 seconds ====================
Doctests interval classes DONE
Check that requirements-dev.txt has been generated from environment.yml
Check that requirements-dev.txt has been generated from environment.yml DONE
The command "ci/code_checks.sh" exited with 1

[TomAugspurger]

The line causing the failure is at https://travis-ci.org/pandas-dev/pandas/jobs/454288173#L2823

[TomAugspurger]

./pandas/core/frame.py:1923:74: W291 trailing whitespace

not sure about why the errors you posted aren't failing the build, but @datapythonista will look at that separately I think.

[datapythonista]

Suggested change

	pandas.io.stata.StataWriter117 : Low-level writer for version 117
	pandas.io.stata.StataWriter117 : Low-level writer for version 117

[datapythonista]

Added a code suggestion removing the whitespace, so you should be able to fix it with a single click.

The error you shown is not really a test error. Is the output of a docstring validation that is being printed (need to check why, as it shouldn't). But that's not really a test failing, is just a "debug" information.

[syutbai]

I pushed the change.

How did you identify the file and line number with the issue?

[TomAugspurger]

Restarted the failing travis build. Not sure what's up with it.

[codecov]

Codecov Report

Merging #23654 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master   #23654      +/-   ##
==========================================
+ Coverage   92.24%   92.24%   +<.01%     
==========================================
  Files         161      161              
  Lines       51317    51318       +1     
==========================================
+ Hits        47338    47339       +1     
  Misses       3979     3979

Flag	Coverage Δ
#multiple	90.63% <100%> (ø)	⬆️
#single	42.31% <63.63%> (-0.01%)	⬇️

Impacted Files	Coverage Δ
pandas/io/json/table_schema.py	98.29% <ø> (ø)	⬆️
pandas/util/_validators.py	96.8% <ø> (ø)	⬆️
pandas/core/base.py	97.61% <ø> (ø)	⬆️
pandas/core/arrays/datetimes.py	98.44% <ø> (ø)	⬆️
pandas/plotting/_core.py	83.63% <ø> (ø)	⬆️
pandas/core/arrays/period.py	98.49% <ø> (ø)	⬆️
pandas/core/indexes/period.py	93.04% <ø> (ø)	⬆️
pandas/core/groupby/groupby.py	96.51% <ø> (ø)	⬆️
pandas/core/arrays/categorical.py	95.34% <ø> (ø)	⬆️
pandas/core/indexes/numeric.py	97.32% <ø> (ø)	⬆️
... and 26 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 a08bf3d...68050f7. Read the comment docs.

[TomAugspurger]

All green. Thanks @syutbai!

[datapythonista]

The exact error was in the travis log. But it's difficult to see if you're not used to it. We're workingon making the errors much clearer in the CI, hopefully that will be deployed soon.