Changes between Version 13 and Version 14 of TracDev/CodingStyle
- Timestamp:
- Dec 30, 2010, 5:03:33 PM (13 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracDev/CodingStyle
v13 v14 3 3 Executive summary: we'll usually frown on patches that 4 4 - have long lines 5 - have multiple statement per lines5 - have multiple statements per line 6 6 - break the naming conventions 7 because this immediately tell us the patch author hasn't tried to follow our coding conventions. On the o pposite, 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 chancesto get the attention it deserves...7 because 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... 8 8 9 9 10 10 Like 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. 11 11 12 Note that there could be that some of the current Trac code violatesa 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.12 Note 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. 13 13 14 14 == Naming conventions ==