diet-ng icon indicating copy to clipboard operation
diet-ng copied to clipboard

The spec should be accompanied by examples which are automatically tested

Open wilzbach opened this issue 8 years ago • 3 comments

I know that this document is incomplete. Hence, this is just an issue to track progress, s.t. it's not forgotten.

The idea is that maybe the spec is generated from a D file with many unittests.

wilzbach avatar Jul 24 '17 15:07 wilzbach

I am having an extremely frustrating time working with Diet templates because the docs are so incomplete. It wasn't until lots of time spent googling turned up the Jade Template docs that I found a doc that covers the syntax in a reasonably complete way, albeit with the caveat that Diet isn't 100% compatible with Jade, so half the time it plain doesn't work, or produces a 2-page compile error that's barely understandable.

tl;dr: documented, automatically-tested examples would be highly appreciated. Also, more complete coverage of the syntax pretty please.

quickfur avatar Dec 09 '17 00:12 quickfur

@quickfur currently the best documentation is the source code itself and the unittest within.

wilzbach avatar Dec 09 '17 00:12 wilzbach

If so, why isn't said unittest part of the doc?!

quickfur avatar Dec 09 '17 00:12 quickfur