best documentation thoughts

currently:

either rspecs that you can designate as “add to documentation”

or

example tutorial/demos that can be runnable. ¬†And then some way to “doc test coverage” of public methods.

Kind of prefer the latter, barely.  Similar to doctest, but maybe not exactly the same.

One thought on “best documentation thoughts

  1. would be interesting to see which if statements are “documentation covered” or not, even within the embedded/private methods themselves.

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>