Re: Proposed documentation guidelines
[email protected] ("Chas. Owens") Fri, 2 Jul 2010 13:44:30 -0400
| Newsgroups | perl.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Jul 2, 2010, at 12:46, Leon Timmermans <[email protected]> wrote: > On Fri, Jul 2, 2010 at 5:17 PM, Chas. Owens <[email protected]> wrote: >> I need to look through what is done today before I put up my version >> of the guidelines, but if you are already familiar with the way Pod is >> used in the existing documents, don't let me stand in the way of you >> proposing some guidelines. >> >> -- >> Chas. Owens >> wonkden.net >> The most important skill a programmer can have is the ability to read. >> > > My suggestion would be to make sure all new code examples are properly > tested by unit tests, and incrementally try to make that true for old > code examples. Examples with bugs in them are rather embarrassing. > > Leon 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.