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

Improve tests #28

Open
3 tasks
rlouf opened this issue May 8, 2020 · 0 comments
Open
3 tasks

Improve tests #28

rlouf opened this issue May 8, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority-3 Not but, low priority issues/PR
Milestone
0.1

Comments

@rlouf
Copy link
Owner

rlouf commented May 8, 2020 •
edited
Loading

Tests not only allow to make sure the code is working as expected but they can also be used to make sure that the documentation and examples are up to date.

  • Test the code examples in the doc
  • Test the code in docstrings
  • Run examples and notebooks to make sure they still work

Documentation should be quite fast to test so can run with the CI after every push. We might need to do a nightly run for the examples. Not sure how that would work with the data either.
@rlouf rlouf added priority-3 Not but, low priority issues/PR documentation Improvements or additions to documentation good first issue Good for newcomers labels May 8, 2020
@rlouf rlouf added this to the 0.1 milestone Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers priority-3 Not but, low priority issues/PR
Projects
None yet
Milestone
0.1
Development

No branches or pull requests
1 participant
@rlouf