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] Finish out Pylibcudf docs #16810

Draft
wants to merge 1 commit into
base: branch-24.10
Choose a base branch
from
Draft

[DOC] Finish out Pylibcudf docs #16810

wants to merge 1 commit into from
+31 −1

Conversation

Matt711
Copy link
Contributor

@Matt711 Matt711 commented Sep 16, 2024

Description

Closes #15937

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@Matt711 Matt711

Labels
2 - In Progress Currently a work in progress doc Documentation non-breaking Non-breaking change pylibcudf Issues specific to the pylibcudf package
Projects
cuDF/Dask/Numba/UCX
Status: In Progress
pylibcudf
Status: No status
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[FEA]: Finish documentation for pylibcudf
2 participants
@Matt711 @mroeschke