[llvm-commits] [llvm] r75406 - /llvm/trunk/docs/CodingStandards.html

[Chris Lattner]

Author: lattner
Date: Sat Jul 11 19:10:24 2009
New Revision: 75406

URL: http://llvm.org/viewvc/llvm-project?rev=75406&view=rev
Log:
be explicit about making comments real sentences.

Modified:
    llvm/trunk/docs/CodingStandards.html

Modified: llvm/trunk/docs/CodingStandards.html
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/CodingStandards.html?rev=75406&r1=75405&r2=75406&view=diff

==============================================================================
--- llvm/trunk/docs/CodingStandards.html (original)
+++ llvm/trunk/docs/CodingStandards.html Sat Jul 11 19:10:24 2009
@@ -118,7 +118,9 @@
 <div class="doc_text">
 
 <p>Comments are one critical part of readability and maintainability.  Everyone
-knows they should comment, so should you.  Although we all should probably
+knows they should comment, so should you.  When writing comments, write them as
+English prose, which means they should use proper capitalization, punctuation,
+etc.  Although we all should probably
 comment our code more than we do, there are a few very critical places that
 documentation is very useful:</p>