Hi Evan Depending on the size of the documentation. - if you have a kind of tutorial I would go (and I can help) for a pillar booklet or a chapter. - else class comments are simply cool with examples
stef On Sat, Aug 5, 2017 at 2:19 AM, Evan Donahue <[email protected]> wrote: > Hello, > > I'm working on cleaning up a couple of projects for release, and I was > wondering what the best practices were for including appropriate > documentation with projects. Should I just drop a text blob in a prominent > class comment? Is there a tool for structuring documentation? Is > documentation typically kept separate from the code? Seems natural to > include it so you never have to leave the image, but I'm not sure what most > people do. > > Thanks, > Evan
