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

Check doctests #6

Open
2 tasks
volcan01010 opened this issue Jul 14, 2022 · 0 comments
Open
2 tasks

Check doctests #6

volcan01010 opened this issue Jul 14, 2022 · 0 comments
Labels
good first issue Good for newcomers

Comments

@volcan01010
Copy link
Owner

Summary

As a BNG.py developer, I want to use doctests to ensure that the documentation is correct.

Description

Doctests run Python code given as examples in docstrings and confirms that the results are as expected.

https://docs.python.org/3/library/doctest.html

BNG has such code in the docstrings, but the tests have never been tried.

Acceptance

  • Add if '__name__' == '__main__' section to allow easy running of doctests
  • Confirm that doctests all pass
@volcan01010 volcan01010 added the good first issue Good for newcomers label Jul 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@volcan01010