Re: Proposed documentation guidelines
[email protected] (Caleb Cushing) Fri, 2 Jul 2010 14:21:00 -0400
| Newsgroups | perl.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Fri, Jul 2, 2010 at 1:44 PM, Chas. Owens <[email protected]> wrote: > I have been thinking about this as well. I need to do more research, but I was hoping we could drop the test code into the pod in =for sections. Test::Synopsis (I think it is) and dzil .. ::SynopsisTests might render clues on how to test code in documentation. On Fri, Jul 2, 2010 at 1:58 PM, Jan Dubois <[email protected]> wrote: > I would rather see some framework that takes the sample code directly > out of the POD. Otherwise you end up with the maintenance issue of > the documentation and the tests being out-of-sync. Having tests that > don't actually test what you think they do is often worse than no > tests at all because they give you a false sense of confidence. > that's exactly what synopsis tests does. although it's a compile test only. p.s. sorry forgetting to reply to all again. -- Caleb Cushing http://xenoterracide.blogspot.com