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

Introduce testing of code examples #50

Open
ghost opened this issue Dec 7, 2017 · 0 comments
Open

Introduce testing of code examples #50

ghost opened this issue Dec 7, 2017 · 0 comments

Comments

@ghost
Copy link

ghost commented Dec 7, 2017

The README file contains a lot of code examples, which tend to get outdated pretty quickly as the API is still undergoing some changes.

It would be nice to keep these code samples in the project codebase (in an examples folder...?), have them all properly unit-tested and dynamically included into the documentation - not necessarily into the README file - so we are sure all of them are always up-to-date.

@ghost ghost added the enhancement label Dec 7, 2017
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

0 participants