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.

Sign up for GitHub

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

Jump to bottom

[DOC] Update Pylibcudf doc strings #16810

Merged
merged 13 commits into from
Sep 25, 2024
Merged

[DOC] Update Pylibcudf doc strings #16810

merged 13 commits into from
Sep 25, 2024

Conversation

Matt711
Copy link
Contributor

@Matt711 Matt711 commented Sep 16, 2024 •
edited
Loading

Description

This PR is a first pass at #15937. We will close #15937 after #15162 is closed

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@Matt711 Matt711 added 2 - In Progress Currently a work in progress doc Documentation improvement Improvement / enhancement to an existing function pylibcudf Issues specific to the pylibcudf package labels Sep 16, 2024
@Matt711 Matt711 self-assigned this Sep 16, 2024
@github-actions github-actions bot added Python Affects Python cuDF API. and removed pylibcudf Issues specific to the pylibcudf package labels Sep 16, 2024
@Matt711 Matt711 added non-breaking Non-breaking change pylibcudf Issues specific to the pylibcudf package and removed Python Affects Python cuDF API. improvement Improvement / enhancement to an existing function labels Sep 16, 2024
@Matt711 Matt711 changed the title [Improvement] Finish out Pylibcudf docs [DOC] Finish out Pylibcudf docs Sep 16, 2024
@mroeschke
Copy link
Contributor

Just an idea if you're interested, for these pylibcudf docstring it might be good to enforce some numpydoc rules to ensure these docstrings are populated with certain sections: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks

Namely, the RT01, PR, SA01, and SS01 rules

@Matt711
Copy link
Contributor Author

Matt711 commented Sep 20, 2024 •
edited
Loading

Just an idea if you're interested, for these pylibcudf docstring it might be good to enforce some numpydoc rules to ensure these docstrings are populated with certain sections: https://numpydoc.readthedocs.io/en/latest/validation.html#built-in-validation-checks

Namely, the RT01, PR, SA01, and SS01 rules

Thanks for the suggestion! Unfortunately, I don't think it works with Cython. Maybe there's a way to get to work on *.pyx files anyway?

@copy-pr-bot copy-pr-bot
Copy link

copy-pr-bot bot commented Sep 20, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions github-actions bot added Python Affects Python cuDF API. and removed pylibcudf Issues specific to the pylibcudf package labels Sep 20, 2024
@Matt711
Copy link
Contributor Author

Matt711 commented Sep 20, 2024

/ok to test

@github-actions github-actions bot added the pylibcudf Issues specific to the pylibcudf package label Sep 21, 2024
@Matt711
Copy link
Contributor Author

Matt711 commented Sep 21, 2024

/ok to test

@Matt711
Copy link
Contributor Author

Matt711 commented Sep 21, 2024

/ok to test

@Matt711
Copy link
Contributor Author

Matt711 commented Sep 23, 2024

/ok to test

@Matt711 Matt711 marked this pull request as ready for review September 23, 2024 13:47
@Matt711 Matt711 requested a review from a team as a code owner September 23, 2024 13:47
@Matt711
Copy link
Contributor Author

Matt711 commented Sep 23, 2024

/ok to test

@vyasr
Copy link
Contributor

vyasr commented Sep 23, 2024

We'll need to make some decision about how many fixes we consider sufficient to close the issue since there will always be more to fix. Maybe we should at least wait until #15162 is closed to say that all of those modules can have fixed docstrings when this PR is merged?

@Matt711 Matt711 changed the title [DOC] Finish out Pylibcudf docs [DOC] Update Pylibcudf doc strings Sep 24, 2024
@Matt711
Copy link
Contributor Author

Matt711 commented Sep 24, 2024

We'll need to make some decision about how many fixes we consider sufficient to close the issue since there will always be more to fix. Maybe we should at least wait until #15162 is closed to say that all of those modules can have fixed docstrings when this PR is merged?

That sounds good to me. I updated the title and PR description.

@Matt711
Copy link
Contributor Author

Matt711 commented Sep 24, 2024

/ok to test

@Matt711
Copy link
Contributor Author

Matt711 commented Sep 25, 2024

/ok to test

@Matt711 Matt711 removed the 2 - In Progress Currently a work in progress label Sep 25, 2024
@galipremsagar galipremsagar added the 5 - Ready to Merge Testing and reviews complete, ready to merge label Sep 25, 2024
@Matt711
Copy link
Contributor Author

Matt711 commented Sep 25, 2024

/merge

@rapids-bot rapids-bot bot merged commit d11ec7a into rapidsai:branch-24.10 Sep 25, 2024
103 checks passed
rjzamora pushed a commit to rjzamora/cudf that referenced this pull request Sep 25, 2024
@Matt711 @rjzamora
[DOC] Update Pylibcudf doc strings (rapidsai#16810)
42a15ee 
This PR is a first pass at rapidsai#15937. We will close rapidsai#15937 after rapidsai#15162 is closed

Authors:
  - Matthew Murray (https://github.com/Matt711)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

URL: rapidsai#16810
Matt711 added a commit to mroeschke/cudf that referenced this pull request Sep 25, 2024
@Matt711
[DOC] Update Pylibcudf doc strings (rapidsai#16810)
c96eb2f 
This PR is a first pass at rapidsai#15937. We will close rapidsai#15937 after rapidsai#15162 is closed

Authors:
  - Matthew Murray (https://github.com/Matt711)

Approvers:
  - GALI PREM SAGAR (https://github.com/galipremsagar)

URL: rapidsai#16810
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@galipremsagar galipremsagar galipremsagar approved these changes

@mroeschke mroeschke Awaiting requested review from mroeschke mroeschke is a code owner automatically assigned from rapidsai/cudf-python-codeowners

Assignees

@Matt711 Matt711

Labels
5 - Ready to Merge Testing and reviews complete, ready to merge doc Documentation non-breaking Non-breaking change pylibcudf Issues specific to the pylibcudf package Python Affects Python cuDF API.
Projects
cuDF/Dask/Numba/UCX
Status: Done
pylibcudf
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEA]: Finish documentation for pylibcudf
4 participants
@Matt711 @mroeschke @vyasr @galipremsagar