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

[FEA] Execute documentation examples in CI tests (doctests) #9513

Closed
bdice opened this issue Oct 25, 2021 · 1 comment · Fixed by #9815
Closed

[FEA] Execute documentation examples in CI tests (doctests) #9513

bdice opened this issue Oct 25, 2021 · 1 comment · Fixed by #9815
Assignees
@bdice
Labels
1 - On Deck To be worked on next feature request New feature or request tests Unit testing for project

Comments

@bdice
Copy link
Contributor

bdice commented Oct 25, 2021 •
edited
Loading

Is your feature request related to a problem? Please describe.
Example code in cuDF is currently untested (as far as I can tell). I discussed with @rlratzel who is working to add doctests to cuGraph, and I'd like to mirror that testing configuration for cuDF.

See also: rapidsai/cugraph#1904

Describe the solution you'd like
Add doctests that execute the example code in docstrings during CI.
@bdice bdice added feature request New feature or request 1 - On Deck To be worked on next tests Unit testing for project labels Oct 25, 2021
@bdice bdice self-assigned this Oct 25, 2021
@rlratzel rlratzel mentioned this issue Oct 25, 2021
Closed
@github-actions
Copy link

This issue has been labeled inactive-30d due to no recent activity in the past 30 days. Please close this issue if no further response or action is needed. Otherwise, please respond with a comment indicating any updates or changes to the original issue and/or confirm this issue still needs to be addressed. This issue will be labeled inactive-90d if there is no activity in the next 60 days.

@bdice bdice mentioned this issue Dec 1, 2021
Merged
9 tasks
rapids-bot bot pushed a commit that referenced this issue Jan 15, 2022
@bdice
Run doctests. (#9815)
e24fa8f 
This PR adds doctests and resolves #9513. Several issues were found by running doctests that have now been resolved:

- [x] #9821
- [x] #9822
- [x] #9823
- [x] #9824
- [x] #9825
- [x] #9826
- [x] #9827
- [x] #9828 (workaround by deleting doctests)
- [x] #9829

Authors:
  - Bradley Dice (https://github.com/bdice)

Approvers:
  - Ashwin Srinath (https://github.com/shwina)
  - Vyas Ramasubramani (https://github.com/vyasr)

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

@bdice bdice

Labels
1 - On Deck To be worked on next feature request New feature or request tests Unit testing for project
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Run doctests. bdice/cudf
1 participant
@bdice