Changes between Version 13 and Version 14 of DevNotes/DevGuide/CodingRules

Timestamp:

May 30, 2016 7:56:37 AM (8 years ago)

Author:

wojciech

Comment:

—

DevNotes/DevGuide/CodingRules

@@ -196 +196 @@
 The proposed access to the core functionality should be consistent for all perspectives and straightforward to use.
 
-    All known input arguments should be set in __init__, during instantiation, with proper checks
-    Additional input data can be set directly through the @property decorator
-
+    * All known input arguments should be set in __init__, during instantiation, with proper checks
+    * Additional input data can be set directly through the @property decorator
+
+        {{{
+        #!div style="font-size: 80%"
         Getters:
-         @property
+        {{{#!python        
+        @property
                def intensity(self):
                      return self.wave.intensity
-
+        }}}
+        }}}
          
-
+        {{{
+        #!div style="font-size: 80%"
         Setters:
-          @intensity.setter
+        {{{#!python        
+        @intensity.setter
                def intensity(self, value):
                     self.wave.set_intensity(intensity)
-    All user accessible input/output data should be available through getters
+        }}}
+        }}}
+    * All user accessible input/output data should be available through getters
      __getattr__ and __setattr__ should be avoided.
-    Main functionality should be exposed as a method with easy to understand name, e.g. calculate() and should return the results object/structure
-    When defining the interface, type hints are an important part of the definition. Type hints are described in PEP-484 https://www.python.org/dev/peps/pep-0484 and should be added for all API methods.
-
+    * Main functionality should be exposed as a method with easy to understand name, e.g. calculate() and should return the results object/structure
+    * When defining the interface, type hints are an important part of the definition. Type hints are described in PEP-484 https://www.python.org/dev/peps/pep-0484 and should be added for all API methods.
+
+    {{{
+    #!div style="font-size: 80%"
+    {{{#!python            
     def fit(self, msg_q=None, q=None, handler=None, curr_thread=None, ftol=1.49012e-8, reset_flag=False):
            # type: (CalcThread.queue, CalcThread.queue, FitHandler, CalcThread, float, bool) -> Union[CalcThread.queue, FResult]
-
-
-    In cases where several pieces of information are calculated at the same time, a list of outputs, a dictionary, or an output object that contains the computed data should be returned
-    Error codes from a method should never be returned - use exceptions
+    }}}
+    }}}
+
+    * In cases where several pieces of information are calculated at the same time, a list of outputs, a dictionary, or an output object that contains the computed data should be returned
+    * Error codes from a method should never be returned - use exceptions