<html><body><div style="color:#000; background-color:#fff; font-family:arial, helvetica, sans-serif;font-size:10pt"><div><span>Personally, I like TomDoc http://tomdoc.org/</span></div><div><br><span></span></div><div><span><br></span></div><div> </div><div><i>James Cumming, CFA<br></i>+44 7799 554468<br></div> <div style="font-family: arial, helvetica, sans-serif; font-size: 10pt;"> <div style="font-family: times new roman, new york, times, serif; font-size: 12pt;"> <font face="Arial" size="2"> <hr size="1"> <b><span style="font-weight:bold;">From:</span></b> Mark Burns <markthedeveloper@gmail.com><br> <b><span style="font-weight: bold;">To:</span></b> London Ruby Users Group <chat@lists.lrug.org> <br> <b><span style="font-weight: bold;">Sent:</span></b> Thursday, 24 November 2011, 18:29<br> <b><span style="font-weight: bold;">Subject:</span></b> Re: [LRUG] Ruby world and documentation<br> </font> <br><div id="yiv292704705">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>
</div><br>_______________________________________________<br>Chat mailing list<br><a ymailto="mailto:Chat@lists.lrug.org" href="mailto:Chat@lists.lrug.org">Chat@lists.lrug.org</a><br><a href="http://lists.lrug.org/listinfo.cgi/chat-lrug.org" target="_blank">http://lists.lrug.org/listinfo.cgi/chat-lrug.org</a><br><br><br> </div> </div> </div></body></html>