Re:Every line of code is always documented
by Dylan16807 on Sunday February 09, 2014 @03:02AM
(#7204807)
Strong disagree. The article is about recommending and making ex post use of a policy for good commit messages. The point argued is in favor of a future rule for good commit messages. Therefore it is very reasonable to suggest a superior rule for the future.
Re:Every line of code is always documented
by jpatte on Sunday February 09, 2014 @03:29AM
(#7204863)
As rymohr indicated, the author of the code given as example is actually the author of the article himself:
https://github.com/madrobby/zepto/commit/3d92f20966aa02dee82...
Which means the OP genuinely thinks that commits like this one are good practice, and the purpose of the article is to show how to deal with it.
Yet as it was argued above, commits like that should never happen in the first place.
Re:Every line of code is always documented
by mislav on Sunday February 09, 2014 @10:15PM
(#7208894)
And it didn't. This was the commit that actually happened: https://github.com/madrobby/zepto/commit/2ed0123eaddc023a857...
Notice the code comment. I took it out for the example in the blog post to illustrate how we would deal if there was never a code comment in the first place.
http://lsolum.typepad.com/legal_theory_lexicon/2003/09/legal...
this article is about recommendations of what to do ex post once a comment-less line of code has been committed in the past that you need to understand. arguments about ex ante things such as how it got there in the first place and how to prevent it from happening is completely orthogonal to the point of the article.