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

docs: use doctests #1498

Closed
Redridge opened this issue Feb 15, 2016 · 4 comments
Closed

docs: use doctests #1498

Redridge opened this issue Feb 15, 2016 · 4 comments

Comments

@Redridge
Copy link
Member

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

@AbdealiLoKo AbdealiLoKo changed the title docs: Rewrite/Improve docs docs: use doctests Feb 24, 2016
@AbdealiLoKo
Copy link
Contributor

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.
Could you give examples ? We mainly have shell commands in the doctests which py.test cannot run.

Our docs majorly talk about creating bears or Linters and stuff - and we cannot exactly run these without running a shell command like coala .... Importing stuff and running it using coala_main would just make things more complicated for the person reading the tutorial.

@Redridge
Copy link
Member Author

If there is no place to run doctest then I think we can close this. I originally filed it guided by @sils1297

@sils
Copy link
Member

sils commented Feb 24, 2016

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.

@Adrianzatreanu
Copy link
Contributor

This issue was moved to coala/documentation#57

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

No branches or pull requests

4 participants