News for hackers. Stuff that matters.
Re:Ruby Patterns from GitHub's Codebase by crymer11 on Thursday March 01, 2012 @12:20AM (#3651032)
Curious as to why you think documenting everything from the start is counterproductive. Are you opposed to documenting everything or documenting from the start, and why?

I mean, I hate writing documentation, but as someone who has had to come back to code I've written months prior (and I was the only one to work on the project), let alone code someone else wrote, I'm incredibly grateful when I look at old code that's actually documented. Plus I feel that writing a couple lines of documentation helps me figure out exactly what I want the code to do.

Re:Ruby Patterns from GitHub's Codebase by whatthefunk on Thursday March 01, 2012 @04:30PM (#3654144)
True. I have been in that situation too. Although I also have some cases wherein I thought prototyping something up to a point to prove it's worth is not subject to "document everything." I guess my question now is, is it better to do it from the very beginning knowing this fact?
Re:Ruby Patterns from GitHub's Codebase by crymer11 on Friday March 02, 2012 @01:36AM (#3655618)
Since I think accurate, up-to-date documentation is as important as existent documentation, I'm inclined to believe that documenting everything doesn't have to be started at the beginning, but I know the longer I put it off, the less likely I am to actually write it. I've been trying to document my code as soon as I have a good idea of how the function, method, etc. is going to work, which sometimes is before I write any code, sometimes after I'm finished, but usually as I'm writing it.