← Back to branch summary

~openerp-community/openobject-doc/ksa-openobject-doc-6.0

« back to all changes in this revision

Viewing changes to i18n/ru/source/contribute/15_guidelines/coding_guidelines.rst

  • Committer: Don Kirkby
  • Date: 2011-02-21 20:46:11 UTC
  • mfrom: (433.1.53 openobject-doc)
  • Revision ID: donkirkby+launpd@gmail.com-20110221204611-1ykt6dmg4k3gh5dh
[MERGE] revisions 477 to 486 from the 5.0 branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
i18n/ru/source/contribute/15_guidelines/coding_guidelines.rst
 
1
 
 
2
.. i18n: .. _coding-guidelines-link:
 
3
.. i18n: 
 
4
.. i18n: =================
 
5
.. i18n: Coding Guidelines
 
6
.. i18n: =================
 
7
.. i18n: This list is populated incrementally as part of the code review process
 
8
.. i18n: done by the OpenERP Quality Team.  It contains a set of OpenERP specific
 
9
.. i18n: good/bad practices, as well as a selection of more generic Python coding
 
10
.. i18n: recommendations.
 
11
..
 
12
 
 
13
.. _coding-guidelines-link:
 
14
 
 
15
=================
 
16
Coding Guidelines
 
17
=================
 
18
This list is populated incrementally as part of the code review process
 
19
done by the OpenERP Quality Team.  It contains a set of OpenERP specific
 
20
good/bad practices, as well as a selection of more generic Python coding
 
21
recommendations.
 
22
 
 
23
.. i18n: Both sections are a MUST READ for every OpenERP developer and contributor.
 
24
..
 
25
 
 
26
Both sections are a MUST READ for every OpenERP developer and contributor.
 
27
 
 
28
.. i18n: As an introductory rule, you should always keep in mind the following:
 
29
..
 
30
 
 
31
As an introductory rule, you should always keep in mind the following:
 
32
 
 
33
.. i18n:   **Every line you write will be written only once, but read many times
 
34
.. i18n:   by others (including yourself)**
 
35
..
 
36
 
 
37
  **Every line you write will be written only once, but read many times
 
38
  by others (including yourself)**
 
39
 
 
40
.. i18n: At the risk of stating the obvious, this means that while following the
 
41
.. i18n: other guidelines, you should always use your best judgment in order to
 
42
.. i18n: achieve the best readability. And if writing readable code requires an
 
43
.. i18n: additional effort, it's worth it a thousand times.
 
44
..
 
45
 
 
46
At the risk of stating the obvious, this means that while following the
 
47
other guidelines, you should always use your best judgment in order to
 
48
achieve the best readability. And if writing readable code requires an
 
49
additional effort, it's worth it a thousand times.
 
50
 
 
51
.. i18n: .. Be careful if you change the following, you don't want to mess up the
 
52
.. i18n:    guidelines numbering -- see the sectnum:: directives !!
 
53
..
 
54
 
 
55
.. Be careful if you change the following, you don't want to mess up the
 
56
   guidelines numbering -- see the sectnum:: directives !!
 
57
 
 
58
.. i18n: .. toctree::
 
59
.. i18n: 
 
60
.. i18n:     coding_guidelines_python
 
61
.. i18n:     coding_guidelines_framework
 
62
.. i18n:     coding_guidelines_testing
 
63
..
 
64
 
 
65
.. toctree::
 
66
 
 
67
    coding_guidelines_python
 
68
    coding_guidelines_framework
 
69
    coding_guidelines_testing