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

Add doctests #177

Closed
felipeZ opened this issue Mar 19, 2020 · 1 comment · Fixed by #207
Closed

Add doctests #177

felipeZ opened this issue Mar 19, 2020 · 1 comment · Fixed by #207
Assignees
@felipeZ
Labels
Tests Updated the unit-tests
Projects
Clean and improve

Comments

@felipeZ
Copy link
Member

felipeZ commented Mar 19, 2020

Add doctests to check that the example code is working.
@felipeZ felipeZ self-assigned this Mar 19, 2020
@felipeZ felipeZ added this to To do in Clean and improve via automation Mar 19, 2020
@BvB93
Copy link
Collaborator

BvB93 commented Jun 18, 2020 •
edited

The built-in sphinx.ext.doctest extension (docs) would be useful here, especially the .. testsetup:: and .. testcleanup:: directives.

As an example: https://github.com/nlesc-nano/data-CAT/blob/cf2b21115b3c2cb22f995074d3167e2e5ead111e/dataCAT/pdb_array.py#L324-L350

@BvB93 BvB93 added Tests Updated the unit-tests and removed enhancement labels Jun 18, 2020
@BvB93 BvB93 mentioned this issue Jun 18, 2020
Merged
@BvB93 BvB93 linked a pull request Jun 18, 2020 that will close this issue
Added doctests #207
Merged
Clean and improve automation moved this from To do to Done Jun 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@felipeZ felipeZ

Labels
Tests Updated the unit-tests
Projects
Clean and improve
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added doctests SCM-NV/qmflows
2 participants
@felipeZ @BvB93