-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
docs: use doctests #1498
Comments
I just went through the documentation. I'm unable to find any specific place where we can use doctests where it's not being used. Our docs majorly talk about creating bears or Linters and stuff - and we cannot exactly run these without running a shell command like |
If there is no place to run doctest then I think we can close this. I originally filed it guided by @sils1297 |
I'm not sure what I was thinking but I think that I was thinking that we could migrate some existing tests into neat documentation examples which would do our docs good. |
This issue was moved to coala/documentation#57 |
In order for the docs to be correct, the code that the docs contain must be correct.
For that matter the docs should be all doctest stable. doctest
Rewrite/Imporve the docs such that they use doctest
difficulty/low
The text was updated successfully, but these errors were encountered: