Also sorry to spam the channel, but cucumber features and RSpec specs provides great documentation for how to use <div>a library. </div><div>README.md-driven, Behaviour, and Test driven development all aid communication of </div>

<div>intent of the code, and how it can be used and what it should be used for.<br><div><br><div class="gmail_quote">On 24 November 2011 18:29, Mark Burns <span dir="ltr"><<a href="mailto:markthedeveloper@gmail.com">markthedeveloper@gmail.com</a>></span> wrote:<br>

<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">I'll just follow that up by saying certain things should be commented:<div><br></div><div>Bad practices that have been temporarily introduced due to time constraints, </div>

<div>e.g. workarounds due to a bug outside of your control, monkey patches to fix an issue before</div>
<div>getting a change accepted in a gem or forking the gem yourself.</div><div><br></div><div>Basically, flags for temporary issues before you can fix the code to be clean and easy to read.</div>
</blockquote></div><br></div></div>