[LRUG] Ruby world and documentation

[James Cumming]

Personally, I like TomDoc http://tomdoc.org/


 
James Cumming, CFA
+44 7799 554468


________________________________
 From: Mark Burns <markthedeveloper at gmail.com>
To: London Ruby Users Group <chat at lists.lrug.org> 
Sent: Thursday, 24 November 2011, 18:29
Subject: Re: [LRUG] Ruby world and documentation
 

I'll just follow that up by saying certain things should be commented:

Bad practices that have been temporarily introduced due to time constraints, 
e.g. workarounds due to a bug outside of your control, monkey patches to fix an issue before
getting a change accepted in a gem or forking the gem yourself.

Basically, flags for temporary issues before you can fix the code to be clean and easy to read.
_______________________________________________
Chat mailing list
Chat at lists.lrug.org
http://lists.lrug.org/listinfo.cgi/chat-lrug.org
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lrug.org/pipermail/chat-lrug.org/attachments/20111124/bd6f25b2/attachment-0003.html>