Changes between Version 49 and Version 50 of Commentary/CodingStyle


Ignore:
Timestamp:
Nov 16, 2014 11:54:02 PM (8 months ago)
Author:
adamse
Comment:

Missing word

Legend:

Unmodified
Added
Removed
Modified
  • Commentary/CodingStyle

    v49 v50  
    103103=== Commit messages ===  
    104104 
    105 Please use commit messages to describe how something works, or give examples, ''even if the patch is devoted to a single change''.  The information is harder to find in a commit message, and (much worse) there is no explicit indication in the code that there is carefully-written information available about that particular line of code.  Instead, you can refer to the Note from the commit message. 
     105Please do not use commit messages to describe how something works, or give examples, ''even if the patch is devoted to a single change''.  The information is harder to find in a commit message, and (much worse) there is no explicit indication in the code that there is carefully-written information available about that particular line of code.  Instead, you can refer to the Note from the commit message. 
    106106 
    107107Commit messages can nevertheless contain substantial information, but it is usually of a global nature.  E.g. "This patch modifies 20 files to implement a new form of inlining pragma".