From: Jesse Vincent Date: Mon, 18 Jan 2010 19:24:36 +0000 (-0800) Subject: Fixed an editing error in perldoc about commit messages. X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=80a0006a93e118d82351c89f52d7433793784e94;p=p5sagit%2Fp5-mst-13.2.git Fixed an editing error in perldoc about commit messages. (Thanks to Aristotle Pagaltzis) --- diff --git a/pod/perlrepository.pod b/pod/perlrepository.pod index 7eae645..2e7c314 100644 --- a/pod/perlrepository.pod +++ b/pod/perlrepository.pod @@ -462,10 +462,10 @@ month or next year. A commit message isn't intended to take the place of comments in your code. Commit messages should describe the change you made, while code -comments should describe the current state of the code. If you've -just implemented a new feature, complete with doc, tests and well- -commented code, a brief commit message will often suffice. If, however, -you've just a single character deep in the parser or lexer, you might +comments should describe the current state of the code. If you've just +implemented a new feature, complete with doc, tests and well-commented +code, a brief commit message will often suffice. If, however, you've +just changed a single character deep in the parser or lexer, you might need to write a small novel to ensure that future readers understand what you did and why you did it.