Mercurial > pylearn
changeset 1178:10bc5ebb5823
coding_style: Added note about the need to provide guidelines for serialization-friendly code
| author | Olivier Delalleau <delallea@iro> |
|---|---|
| date | Fri, 17 Sep 2010 16:21:55 -0400 |
| parents | fab72f424ee0 |
| children | 67f4edabb0cc |
| files | doc/v2_planning/API_coding_style.txt doc/v2_planning/coding_style.txt |
| diffstat | 2 files changed, 11 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/v2_planning/API_coding_style.txt Fri Sep 17 14:37:08 2010 -0400 +++ b/doc/v2_planning/API_coding_style.txt Fri Sep 17 16:21:55 2010 -0400 @@ -517,4 +517,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). +
--- a/doc/v2_planning/coding_style.txt Fri Sep 17 14:37:08 2010 -0400 +++ b/doc/v2_planning/coding_style.txt Fri Sep 17 16:21:55 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. +