[Date Prev][Date Next][Thread Prev][Thread Next]
[Date Index]
[Thread Index]
- Subject: Re: Documentation (was Re: PIL 4 Just Arrived!!!)
- From: steve donovan <steve.j.donovan@...>
- Date: Sat, 1 Oct 2016 08:52:22 +0200
On Sat, Oct 1, 2016 at 8:45 AM, Russell Haley <russ.haley@gmail.com> wrote:
> LDoc allows for multiple return statements. Oh, just found --all for
> local functions. Ah, the ecstasy of documentation tools!
As Sean says: documentation is hard. Plus, doc tools make it easier to
believe that you _have_ documented something ;) (I present Javadoc as
an example of something that looks like documentation, and LDoc is
very much in that tradition)
No substitute for clear paragraphs of text, I suppose! Most projects
are very happy to receive PRs for improving documentation, so you can
scratch an itch and be useful to thousands of puzzled people at the
same time ;)
steve d.
