diff options
| author | Martin Trigaux <mat@odoo.com> | 2016-04-26 14:56:44 +0200 |
|---|---|---|
| committer | Martin Trigaux <mat@odoo.com> | 2016-04-26 14:58:31 +0200 |
| commit | 842a8e6952992551cdc46e5ec23a48a3e4920b6e (patch) | |
| tree | 2522130fac8df39fdcf9a01ad458e973654d4c0b /doc/reference/guidelines.rst | |
| parent | eae045949d65fb4236e1d7b3fc3e806673711fe1 (diff) | |
[IMP] doc: add guidelines warning
To prevent huge chunk of modifications for styling reasons (e.g. mass PEP8
commits)
Diffstat (limited to 'doc/reference/guidelines.rst')
| -rw-r--r-- | doc/reference/guidelines.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/reference/guidelines.rst b/doc/reference/guidelines.rst index 5672aabf92c..54a00097705 100644 --- a/doc/reference/guidelines.rst +++ b/doc/reference/guidelines.rst @@ -11,6 +11,14 @@ aim to improve the quality of the code (better readability of source, ...) and Odoo Apps. Indeed, proper code ought ease maintenance, aid debugging, lower complexity and promote reliability. +.. warning:: + + These guidelines are written with new modules and new files in mind. When + modifying existing files, the original style of the file strictly supersedes + any other style guidelines. In other words, never modify existing files in + order to apply these guidelines, to avoid disrupting the revision history of + each line. For more details, see our `pull request guide <https://odoo.com/submit-pr>`_. + Module structure ================ |
