[LRUG] Ruby world and documentation

[Mark Burns]

Also sorry to spam the channel, but cucumber features and RSpec specs
provides great documentation for how to use
a library.
README.md-driven, Behaviour, and Test driven development all aid
communication of
intent of the code, and how it can be used and what it should be used for.

On 24 November 2011 18:29, Mark Burns <markthedeveloper at gmail.com> wrote:

> 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.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.lrug.org/pipermail/chat-lrug.org/attachments/20111124/852a92fb/attachment-0003.html>