Edgewall Software

Changes between Version 13 and Version 14 of TracDev/CodingStyle


Ignore:
Timestamp:
Dec 30, 2010, 5:03:33 PM (13 years ago)
Author:
anonymous
Comment:

minor spelling changes

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/CodingStyle

    v13 v14  
    33Executive summary: we'll usually frown on patches that
    44 - have long lines
    5  - have multiple statement per lines
     5 - have multiple statements per line
    66 - break the naming conventions
    7 because this immediately tell us the patch author hasn't tried to follow our coding conventions. On the opposite, a patch that follows the conventions detailed below tell us that the patch author has made some efforts, therefore the patch itself is much more likely to be a [[TracDev/SubmittingPatches#Whatisagoodpatch|good patch]] and has better chances to get the attention it deserves...
     7because this immediately tell us the patch author hasn't tried to follow our coding conventions. On the other hand, a patch that follows the conventions detailed below tells us that the patch author has made some effort, therefore the patch itself is much more likely to be a [[TracDev/SubmittingPatches#Whatisagoodpatch|good patch]] and has a better chance to get the attention it deserves...
    88
    99
    1010Like most Python projects, we try to adhere to [pep:0008 PEP 8 (Style Guide for Python Code)] and [pep:0257 PEP 257 (Docstring Conventions)]. Be sure to read those documents if you intend to contribute code to Trac.
    1111
    12 Note that there could be that some of the current Trac code violates a couple of the rules stated below. We are always in the process of refactoring the offending modules so that all code uses the same conventions, though it's much better now than it used to be.
     12Note that some of the current Trac code could violate a couple of the rules stated below. We are always in the process of refactoring the offending modules so that all code uses the same conventions, though it's much better now than it used to be.
    1313
    1414== Naming conventions ==