5 ms·
This is one of the reasons why I like Python more than Ruby, the emphasis on not writing documentation, guys, get over it, you always need documentation, self-d
by igorgue 15y ago
This is one of the reasons why I like Python more than Ruby, the emphasis on not writing documentation, guys, get over it, you always need documentation, self-documented code is a huge lie.
What's next? Tests are a waste of time?
P.S.: Not all Ruby programmers are like that obviously that's why this exists http://tomdoc.org/ http://tomdoc.org/ Zack thinks the same way http://twitter.com/#!/holman/status/144579142367711234 http://twitter.com/#!/holman/status/144579142367711234 And there's a good movement of Ruby hackers that think that way.
- saturnflyer 15y agoThis book isn't an argument against documentation. Until the recent advent of DCI there was no programming paradigm that brought the algorithm to be a first class citizen. Tomdoc looks great, but it only describes methods or classes. Documentation will not tell you what will happen among a network objects during runtime, DCI will.
- igorgue 15y agoGot it. "While following the Model View Controller approach has made your code cleaner, and following conventions have reduced the need for documentation, there’s still plenty of room for improvement and too much time needed to instruct new developers." That made me think that the goal was writing less documentation.
- saturnflyer 15y agoInteresting. Maybe I'll rewrite that bit. Thanks for pointing that out.
- nwmcsween 15y agoMost if not all projects in use written in ruby use rdoc, rocco or some form of inline documentation. I would be very surprised if a well used gem didn't have documentation.
- charliesome 15y agoWEBrick?
- sunnyprogram 15y agoI disagree. If you follow test driven development, your tests become your documentation. Want to know what a method does? Look at the tests for the method where it explicitly says what the method is doing and ensures it is functioning correctly.
- masklinn 15y ago> If you follow test driven development, your tests become your documentation. That's the shittiest documentation in existence. Your tests are implementation documentation, they're useful (maybe) for other maintainers, and useless for third-parties trying to actually use your code. > Want to know what a method does? Look at the tests for the method where it explicitly says what the method is doing and ensures it is functioning correctly. Right, look at 700 lines of edge cases testing, that's informative and helpful. Not.
- ollysb 15y agoThat's the difference between TDD and BDD, if you're practicing BDD then your tests will be documenting how to use your code, not how it's implementation works.
- masklinn 15y ago> if you're practicing BDD then your tests will be documenting how to use your code I'm going to call bullshit on that one all the same.