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

[REVIEW] Update missing docstring examples in python public APIs #7546

Merged
merged 8 commits into from
Mar 10, 2021

Conversation

galipremsagar
Copy link
Contributor

@galipremsagar galipremsagar commented Mar 10, 2021

Fully resolves: #5290

This PR:

  • Adds missing docstring examples in python public APIs.
  • Adds some missing alias APIs.
  • Fixes issue in Series.take where the index was not correctly being removed when keep_index=False.
  • Removes Series.values_to_string, this API seems to be have been touched 4-years ago and since we have removed support for iterating over GPU objects thought it is best to remove this API altogether.

@galipremsagar galipremsagar added bug Something isn't working 3 - Ready for Review Ready for review by team Python Affects Python cuDF API. 4 - Needs cuDF (Python) Reviewer breaking Breaking change labels Mar 10, 2021
@galipremsagar galipremsagar self-assigned this Mar 10, 2021
@galipremsagar galipremsagar requested a review from a team as a code owner March 10, 2021 03:49
@kkraus14 kkraus14 added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team 4 - Needs cuDF (Python) Reviewer labels Mar 10, 2021
@kkraus14
Copy link
Collaborator

@gpucibot merge

@codecov
Copy link

codecov bot commented Mar 10, 2021

Codecov Report

Merging #7546 (2839b7c) into branch-0.19 (7871e7a) will increase coverage by 0.04%.
The diff coverage is 92.30%.

Impacted file tree graph

@@               Coverage Diff               @@
##           branch-0.19    #7546      +/-   ##
===============================================
+ Coverage        81.86%   81.90%   +0.04%     
===============================================
  Files              101      101              
  Lines            16884    16900      +16     
===============================================
+ Hits             13822    13842      +20     
+ Misses            3062     3058       -4     
Impacted Files Coverage Δ
python/cudf/cudf/core/dataframe.py 90.46% <ø> (ø)
python/cudf/cudf/core/index.py 92.86% <ø> (ø)
python/cudf/cudf/core/column/column.py 87.70% <75.00%> (-0.06%) ⬇️
python/cudf/cudf/core/series.py 91.10% <90.00%> (+0.32%) ⬆️
python/cudf/cudf/core/column/decimal.py 95.83% <100.00%> (+0.96%) ⬆️
python/cudf/cudf/core/column/string.py 86.55% <100.00%> (+0.05%) ⬆️
python/cudf/cudf/core/dtypes.py 90.27% <0.00%> (+0.54%) ⬆️

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 850548d...2839b7c. Read the comment docs.

@rapids-bot rapids-bot bot merged commit 2e4b5a6 into rapidsai:branch-0.19 Mar 10, 2021
hyperbolic2346 pushed a commit to hyperbolic2346/cudf that referenced this pull request Mar 25, 2021
Fully resolves: rapidsai#5290 

This PR:

- [x] Adds missing docstring examples in python public APIs.
- [x] Adds some missing alias APIs.
- [x] Fixes issue in `Series.take` where the index was not correctly being removed when `keep_index=False`.
- [x] **Removes** `Series.values_to_string`, this API seems to be have been touched 4-years ago and since we have removed support for iterating over GPU objects thought it is best to remove this API altogether.

Authors:
  - GALI PREM SAGAR (@galipremsagar)

Approvers:
  - Keith Kraus (@kkraus14)

URL: rapidsai#7546
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Ready to Merge Testing and reviews complete, ready to merge breaking Breaking change bug Something isn't working Python Affects Python cuDF API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Some APIs are missing doc examples
2 participants