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

use documentation unittests to guarantee docs stays in sync with code and compiles (http://dcv.dlang.io/) #104

Open
timotheecour opened this issue Jun 8, 2017 · 3 comments

Comments

@timotheecour
Copy link
Collaborator

No description provided.

@ljubobratovicrelja
Copy link
Member

I've setup the example code to have more complete form, with imports, main and all that, so it can be runable. At first I wanted to import each symbol individually, but it seemed to be too much, so I decided to "import" only root package dcv, and link each relevant symbol to it's web documentation, including mir calls.

Theres a ton of work to be done in this part, starting with updating documentation and examples to match the new ndslice API. But anyhow, thank you for reporting this.

Please let me know if there's anything else. If not, please close the issue.

@timotheecour
Copy link
Collaborator Author

ya, the simpler the code the better to not scare away people, the important thing is that the code compiles and runs

@timotheecour
Copy link
Collaborator Author

reopening as I'm noticing the examples are in readme.md instead of embedded in code.

why not use documentation unittests? (https://dlang.org/spec/unittest.html)
This will guarantee they stay in sync with code changes, just as is done in phobos and other projects

@timotheecour timotheecour reopened this Jun 14, 2017
@timotheecour timotheecour changed the title please provide required imports in example given in http://dcv.dlang.io/ use documentation unittests to guarantee docs stays in sync with code and compiles (http://dcv.dlang.io/) Jun 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants