changeset 1257:d79070c60546

merge
author gdesjardins
date Fri, 24 Sep 2010 12:54:27 -0400
parents bf41991692ea (current diff) 58a6919d3649 (diff)
children c88db30f4e08
files
diffstat 2 files changed, 23 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/doc/v2_planning/API_coding_style.txt	Fri Sep 24 12:53:53 2010 -0400
+++ b/doc/v2_planning/API_coding_style.txt	Fri Sep 24 12:54:27 2010 -0400
@@ -218,6 +218,19 @@
         def f(array=[]): # Dangerous if `array` is modified down the road.
             ...
 
+    * All top-level classes should inherit from ``object``. It makes some
+      'under-the-hood' differences that can be very useful for Python black
+      magic adepts.
+
+      .. code-block:: python
+
+        # Good.
+        class MyClass(object):
+            pass
+        # Bad.
+        class MyClass:
+            pass
+
     * Always raise an exception with ``raise MyException(args)`` where ``MyException``
       inherits from ``Exception``. This is required for compatibility across
       all versions of Python.
--- a/doc/v2_planning/coding_style.txt	Fri Sep 24 12:53:53 2010 -0400
+++ b/doc/v2_planning/coding_style.txt	Fri Sep 24 12:54:27 2010 -0400
@@ -500,3 +500,13 @@
 We need to add coding style guidelines to make sure code is properly
 serializable.
 
+Meeting 2010/09/24
+------------------
+
+FB: Look into commit guidelines.
+DE: Write guidelines on how to document a class / method (maybe also some
+typical class like an Op)
+DWF: Write guidelines on how to write serializable code
+OD: Finish code sample that showcases all (or many) guidelines, look into
+feasibility of passing arguments to super classes with **kw.
+