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] Fix some docstrings formatting #10660

Merged
merged 4 commits into from
Apr 14, 2022

Conversation

galipremsagar
Copy link
Contributor

This PR fixes some of the broken docstring formattings in the code-base.

@galipremsagar galipremsagar requested a review from a team as a code owner April 14, 2022 15:54
@galipremsagar galipremsagar self-assigned this Apr 14, 2022
@github-actions github-actions bot added the Python Affects Python cuDF API. label Apr 14, 2022
@galipremsagar galipremsagar added 3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change labels Apr 14, 2022
@codecov
Copy link

codecov bot commented Apr 14, 2022

Codecov Report

Merging #10660 (9e6c890) into branch-22.06 (3c13ef1) will increase coverage by 0.03%.
The diff coverage is 90.51%.

❗ Current head 9e6c890 differs from pull request most recent head 176568b. Consider uploading reports for the commit 176568b to get more accurate results

@@               Coverage Diff                @@
##           branch-22.06   #10660      +/-   ##
================================================
+ Coverage         86.33%   86.37%   +0.03%     
================================================
  Files               140      142       +2     
  Lines             22289    22356      +67     
================================================
+ Hits              19244    19310      +66     
- Misses             3045     3046       +1     
Impacted Files Coverage Δ
python/cudf/cudf/core/_base_index.py 85.45% <ø> (ø)
python/cudf/cudf/core/algorithms.py 90.47% <ø> (ø)
python/cudf/cudf/core/cut.py 82.69% <ø> (ø)
python/cudf/cudf/core/groupby/groupby.py 91.72% <ø> (+0.22%) ⬆️
python/cudf/cudf/core/indexed_frame.py 91.77% <ø> (ø)
python/cudf/cudf/core/multiindex.py 92.14% <ø> (ø)
python/cudf/cudf/core/series.py 95.28% <ø> (ø)
python/cudf/cudf/core/tools/numeric.py 89.24% <ø> (ø)
python/cudf/cudf/utils/cudautils.py 59.83% <ø> (ø)
python/cudf/cudf/utils/ioutils.py 79.60% <ø> (ø)
... and 15 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 14a3261...176568b. Read the comment docs.

@bdice
Copy link
Contributor

bdice commented Apr 14, 2022

@galipremsagar I have a complementary PR in progress - it doesn't overlap much with this one, but let me know if you plan to expand the scope of this PR.

@brandon-b-miller
Copy link
Contributor

Thanks for taking care of this @galipremsagar

@galipremsagar
Copy link
Contributor Author

@galipremsagar I have a complementary PR in progress - it doesn't overlap much with this one, but let me know if you plan to expand the scope of this PR.

I was looking to expand the scope, but thanks for letting me. Let's coordinate offline.

@vyasr vyasr added 0 - Blocked Cannot progress due to external reasons 5 - DO NOT MERGE Hold off on merging; see PR for details and removed 0 - Blocked Cannot progress due to external reasons labels Apr 14, 2022
@vyasr
Copy link
Contributor

vyasr commented Apr 14, 2022

@galipremsagar this looks good to me, but just to prevent any overzealous reviewers from reviewing prematurely before you and @bdice sort out PR scopes I've marked this as DO NOT MERGE. Feel free to ping if you need extra reviews/eyes.

@bdice bdice removed the 5 - DO NOT MERGE Hold off on merging; see PR for details label Apr 14, 2022
@bdice
Copy link
Contributor

bdice commented Apr 14, 2022

@vyasr We chatted and we're going to merge #10663 first. This PR may have minor conflicts in one spot but should be ready for review.

@galipremsagar
Copy link
Contributor Author

This is now ready for review

Copy link
Contributor

@bdice bdice left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks Prem!

Also: nice to learn about Sphinx's nitpick_ignore.

@galipremsagar galipremsagar added 5 - Ready to Merge Testing and reviews complete, ready to merge and removed 3 - Ready for Review Ready for review by team labels Apr 14, 2022
@galipremsagar
Copy link
Contributor Author

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 6e6c325 into rapidsai:branch-22.06 Apr 14, 2022
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 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.

4 participants