Mercurial > pylearn

comparison doc/v2_planning/API_coding_style.txt @ 1148:2da593b0f29d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
API_coding_style: Moved code sample at end of document for better readability
author Olivier Delalleau <delallea@iro>
date Thu, 16 Sep 2010 16:25:38 -0400
parents f6011a2aff0b
children d7192e52653e
comparison
equal deleted inserted replaced
1147:f6011a2aff0b 1148:2da593b0f29d
11 11
12 * Code should be easy to read, understand and update by developers and 12 * Code should be easy to read, understand and update by developers and
13 users. 13 users.
14 14
15 * Code should be well-documented and well-tested. 15 * Code should be well-documented and well-tested.
16
17 Code Sample
18 ===========
19
20 The following code sample illustrates many of the coding guidelines one should
21 follow in Pylearn.
22
23 .. code-block:: python
24
25 import os, sys, time
26 16
27 Python Coding Guidelines 17 Python Coding Guidelines
28 ======================== 18 ========================
29 19
30 Official Guidelines 20 Official Guidelines
155 function/class/method is slated for deprecation in a coming release (early 145 function/class/method is slated for deprecation in a coming release (early
156 in the library's lifetime, ``DeprecationWarning`` will likely be the most common 146 in the library's lifetime, ``DeprecationWarning`` will likely be the most common
157 case). The warning message issued through this facility should avoid 147 case). The warning message issued through this facility should avoid
158 referring to Pylearn internals. 148 referring to Pylearn internals.
159 149
150 Code Sample
151 ===========
152
153 The following code sample illustrates many of the coding guidelines one should
154 follow in Pylearn.
155
156 .. code-block:: python
157
158 import os, sys, time
159