Skip to content
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

Merged
merged 1 commit into from
Apr 12, 2022

Conversation

bdice
Copy link
Contributor

@bdice bdice commented Apr 12, 2022

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:

.../cudf/docs/cudf/source/api_docs/api/cudf.Series.pct_change.rst: WARNING: document isn't included in any toctree

and this one, which indicates that a documented method no longer exists:

WARNING: [autosummary] failed to import cudf.Series.ceil.
Possible hints:
* ModuleNotFoundError: No module named 'cudf.Series'
* AttributeError: type object 'Series' has no attribute 'ceil'
* ImportError:

This PR doesn't fix all of the warnings/errors, but it is a good chunk of them.

@bdice bdice added doc Documentation improvement Improvement / enhancement to an existing function non-breaking Non-breaking change labels Apr 12, 2022
@bdice bdice self-assigned this Apr 12, 2022
@bdice bdice requested a review from a team as a code owner April 12, 2022 19:02
@github-actions github-actions bot added the Python Affects Python cuDF API. label Apr 12, 2022
@bdice bdice removed the improvement Improvement / enhancement to an existing function label Apr 12, 2022
@@ -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>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are indexing docs gone?

Copy link
Contributor Author

@bdice bdice Apr 12, 2022

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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
Copy link

codecov bot commented Apr 12, 2022

Codecov Report

Merging #10643 (dd0cae8) into branch-22.06 (3c13ef1) will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@               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     
Impacted Files Coverage Δ
python/cudf/cudf/core/algorithms.py 90.47% <ø> (ø)
python/cudf/cudf/core/dataframe.py 93.59% <ø> (ø)
python/cudf/cudf/core/groupby/groupby.py 91.72% <ø> (+0.22%) ⬆️
python/cudf/cudf/core/multiindex.py 92.14% <ø> (ø)
python/cudf/cudf/core/series.py 95.28% <ø> (ø)
python/cudf/cudf/core/single_column_frame.py 96.45% <ø> (ø)
python/cudf/cudf/utils/cudautils.py 59.83% <ø> (ø)
python/cudf/cudf/utils/ioutils.py 79.60% <ø> (ø)
python/cudf/cudf/utils/utils.py 90.28% <ø> (ø)
python/cudf/cudf/core/column/lists.py 92.79% <100.00%> (+1.38%) ⬆️
... and 6 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 9e8e92c...dd0cae8. Read the comment docs.

@galipremsagar
Copy link
Contributor

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 64a811e into rapidsai:branch-22.06 Apr 12, 2022
@bdice bdice deleted the docs/add-missing-methods branch April 19, 2022 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation non-breaking Non-breaking change Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants