Skip to content

DOC: add more links to the API in advanced.rst #22746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 19, 2018

Conversation

topper-123
Copy link
Contributor

Links were added to advanced.rst in #22671, but after reading the docs over agian, there still are some links missing and some are strangely placed. Changes consist mainly of:

  • add links for first-time encounters for more methods
  • make fewer links to DataFrame.xs (only keep first link
  • Moved some links from headers to the first encounter in the body

@topper-123 topper-123 changed the title DOC: add more links to advanced.rst DOC: add more links to the API in advanced.rst Sep 18, 2018
@jschendel jschendel added the Docs label Sep 18, 2018
@@ -213,8 +214,8 @@ tuples:
s + s[:-2]
s + s[::2]

``reindex`` can be called with another ``MultiIndex``, or even a list or array
of tuples:
The :meth:`~DataFrame.reindex` method of Series/DataFrames can be called with
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add backticks: Series/DataFrames --> ``Series``/``DataFrame``

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not contradicting, just curious: couldn't it also be ``Series/DataFrame``?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the difference would whether the "/" gets styled as code or not: "Series/DataFrame" vs "Series/DataFrame". I could be wrong though, and maybe reST is smarter than markdown in that regard.

@codecov
Copy link

codecov bot commented Sep 18, 2018

Codecov Report

Merging #22746 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #22746   +/-   ##
=======================================
  Coverage   92.16%   92.16%           
=======================================
  Files         169      169           
  Lines       50769    50769           
=======================================
  Hits        46791    46791           
  Misses       3978     3978
Flag Coverage Δ
#multiple 90.57% <ø> (ø) ⬆️
#single 42.32% <ø> (ø) ⬆️

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 1a12c41...ac0ef7a. Read the comment docs.

@TomAugspurger TomAugspurger merged commit 51aeba4 into pandas-dev:master Sep 19, 2018
@TomAugspurger
Copy link
Contributor

Thanks!

@TomAugspurger TomAugspurger added this to the 0.24.0 milestone Sep 19, 2018
@topper-123 topper-123 deleted the advanced.rst_II branch September 19, 2018 16:41
aeltanawy pushed a commit to aeltanawy/pandas that referenced this pull request Sep 20, 2018
Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this pull request Oct 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants