Changes between Version 16 and Version 17 of DevNotes/DevGuide/CodingRules

Timestamp:

May 30, 2016 6:52:31 AM (8 years ago)

Author:

wojciech

Comment:

—

DevNotes/DevGuide/CodingRules

@@ -60 +60 @@
     * Use _box_car with a leading underscore for non-public methods and _CamelCase with a leading underscore for non-public classes.
     * Never use __box_car__ with leading and trailing double underscores
-    * Avoid one-letter variable names.
-
+    * Avoid one-letter variable names (unless is acceptable one letter variable name or it is justified by the math in the paper)
+    * Don't make long variable names just to keep lint happy:
+      {{{
+      #!div style="font-size: 80%"
+      {{{#!python  
+      [(value, key) for key, value in translation_dictionary.items()]
+      }}}
+      }}}
+      is no better than:
+      {{{
+      #!div style="font-size: 80%"
+      {{{#!python  
+      [(v, k) for k, v in translation_dictionary.items()]
+      }}}
+      }}}
+      but the following is:
+      {{{
+      #!div style="font-size: 80%"
+      {{{#!python  
+      [(latin, english) for english, latin in translation_dictionary.keys()]
+      }}}
+      }}}
     * Models: for adding a new model no capitalization and thus no CamelCase in model names. If necessary use underscore to separate (i.e. barbell not BarBell or broad_peak not BroadPeak)
     * Models: Don't add/Remove “model” in/from the name (i.e. barbell not BarBellModel)