documentable unittest

[H. S. Teoh]

On Thu, Feb 07, 2013 at 03:34:24PM -0800, H. S. Teoh wrote:
> On Thu, Feb 07, 2013 at 03:16:04PM -0800, H. S. Teoh wrote:
> > On Thu, Feb 07, 2013 at 05:53:59PM -0500, Andrei Alexandrescu wrote:
> > > I'm very happy that this will be part of the upcoming release:
> > > https://github.com/D-Programming-Language/dmd/pull/1342 (see also
> > > http://d.puremagic.com/issues/show_bug.cgi?id=2630) allows
> > > defining unittests that simultaneously work as documentation. This
> > > is a great way to simultaneously write meaningful tests and good
> > > documentation examples.
> > > 
> > > If you want to help, feel free to hop on the Phobos documentation
> > > and convert some of it to use the new feature.
> > [...]
> > 
> > Hmm. I notice that comments in the unittest are not included in the
> > generated documentation. This is a bit unfortunate, if you wish to
> > point out something in the example code.
> [...]
> 
> http://d.puremagic.com/issues/show_bug.cgi?id=9472
> http://d.puremagic.com/issues/show_bug.cgi?id=9473
> http://d.puremagic.com/issues/show_bug.cgi?id=9474
[...]

http://d.puremagic.com/issues/show_bug.cgi?id=9475

Sorry for being such a bugbear, ;-) but I really want to see this
feature succeed!


T

-- 
Programming is not just an act of telling a computer what to do: it is
also an act of telling other programmers what you wished the computer to
do. Both are important, and the latter deserves care. -- Andrew Morton