Changes between Version 34 and Version 35 of Development/CodeConventions


Ignore:
Timestamp:
Dec 5, 2012, 12:07:34 PM (7 years ago)
Author:
benl
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Development/CodeConventions

    v34 v35  
    99
    1010=== Comments ===
    11  * If you can't work something out then open a ticket on the trac and set the ticket type to `document`. If you tried to understand something but failed to do so in a reasonable timeframe, then this is a bug against the maintainability of the software. Don't assume that the next person that looks at the same code will be able to make more sense of it than you can.
     11 * If you can't work something out then open a ticket on the trac and set the ticket type to `document`. If you tried to understand something but failed to do so in a reasonable timeframe, then this is a bug against the maintainability of the software. Don't assume that the next person that looks at the same code will be able to make more sense of it than you could.
    1212
    1313 * Each top-level definition should have a comment explaining what it is for. One liners are fine.