-
Notifications
You must be signed in to change notification settings - Fork 915
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
Add missing APIs to documentation. #10643
Add missing APIs to documentation. #10643
Conversation
@@ -59,9 +60,6 @@ Indexing, iteration | |||
Series.iteritems | |||
Series.keys | |||
|
|||
For more information on ``.at``, ``.iat``, ``.loc``, and | |||
``.iloc``, see the :ref:`indexing documentation <indexing>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are indexing docs gone?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They never existed, as far as I can tell!
I searched through the history from branch-0.14
to branch-22.04
and never found the file indexing.rst
. I suspect this was copied from pandas and never checked. It was meant to point to https://github.com/pandas-dev/pandas/blob/main/doc/source/user_guide/indexing.rst. Originally added in PR #8746.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, my mistake. Sorry for that, should we also be having a similar page to https://pandas.pydata.org/docs/user_guide/indexing.html#indexing? Not in the scope of this PR but we can track in an open issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we need it. If we do need it, we could have an outbound link to the pandas docs and avoid maintaining such a page.
Codecov Report
@@ Coverage Diff @@
## branch-22.06 #10643 +/- ##
================================================
+ Coverage 86.33% 86.37% +0.04%
================================================
Files 140 140
Lines 22289 22290 +1
================================================
+ Hits 19244 19254 +10
+ Misses 3045 3036 -9
Continue to review full report at Codecov.
|
@gpucibot merge |
This adds a bunch of missing methods to the documentation and removes methods that no longer exist.
When building, Sphinx issues warnings like this one, which indicates that a method isn't documented:
and this one, which indicates that a documented method no longer exists:
This PR doesn't fix all of the warnings/errors, but it is a good chunk of them.