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.

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

Doctests #145

Open
znicholls opened this issue Oct 13, 2018 · 1 comment
Open

Doctests #145

znicholls opened this issue Oct 13, 2018 · 1 comment

Comments

@znicholls
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

At the moment docstrings are untested.

Describe the solution you'd like

Enable sphinx's doctest extension, see here.

Describe alternatives you've considered

Use some other solution, don't test the docstrings or don't have docstrings.

Additional context

We've got sphinx now, this shouldn't be hugely painful.

@rgieseke
Copy link
Member

Some neat documentation ideas in here (not sure if applicable ...) https://simonwillison.net/2018/Jul/28/documentation-unit-tests/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants