# HG changeset patch # User Olivier Delalleau # Date 1284755031 14400 # Node ID 67f4edabb0cc9c462977a0b57a2cdd4a2edeacbf # Parent 10bc5ebb58237af2921052392708eb5b78aa3185# Parent b699d096e6cc471ac242695a8f3731ff60b6203a Merged diff -r b699d096e6cc -r 67f4edabb0cc doc/v2_planning/API_coding_style.txt --- a/doc/v2_planning/API_coding_style.txt Fri Sep 17 16:20:14 2010 -0400 +++ b/doc/v2_planning/API_coding_style.txt Fri Sep 17 16:23:51 2010 -0400 @@ -519,4 +519,9 @@ - Enforcing 100% test coverage of the code base - Providing ways to add type checking for function arguments - Conventions for script usage documentation and argument parsing + - Conventions for class / method / function documentation + - Guidelines for serialization-friendly code (hint: nested and lambda + functions, as well as instance methods, cannot be serialized, and + apparently there are some issues with decorators -- to be investigated). + diff -r b699d096e6cc -r 67f4edabb0cc doc/v2_planning/coding_style.txt --- a/doc/v2_planning/coding_style.txt Fri Sep 17 16:20:14 2010 -0400 +++ b/doc/v2_planning/coding_style.txt Fri Sep 17 16:23:51 2010 -0400 @@ -484,3 +484,9 @@ OD: It would be nice to have some standardized way of parsing a script's arguments and displaying the script usage doc to the user. +Recommendations for serialization +--------------------------------- + +We need to add coding style guidelines to make sure code is properly +serializable. +