Commit Graph
43 Commits
Author SHA1 Message Date
Victor Feyens 5eec683183 [IMP] doc: guidelines references + minor corrections
X-original-commit: c83e999c6a8b16f78dfd9f944936439a53d2b52f
2019-10-25 15:25:01 +00:00
Muhammad Awais 0c1dbed1bc [FIX] doc: add missing ">"
Unclosed tag

closes odoo/odoo#37744

X-original-commit: a0612f5a17e08e13362034203995944756a7c0be
Signed-off-by: Nicolas Martinelli (nim) <nim@odoo.com>
2019-10-01 18:28:57 +00:00
mreficent 355a5dfc36 [IMP] *: fix typos in comments
closes odoo/odoo#35404

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2019-08-07 10:28:33 +00:00
Yenthe666 ce00210b61 [IMP] doc: remove calls to @api.multi and @api.one
Those two decorators are removed/deprecated since recent commits but some references remained in the documentation.

api.multi is deprecated since https://github.com/odoo/odoo/commit/cc62447a44c2cf4e2edaf8a1f6d94520e799ddd9
api.one was removed with https://github.com/odoo/odoo/commit/407f1f6cdb87a59bbad9f853078d7345cdf9f60c

closes odoo/odoo#35261

Signed-off-by: Martin Trigaux (mat) <mat@odoo.com>
2019-07-30 15:39:19 +00:00
Adrian Torres 4b38cc6590 [REM] *: calls to @api.multi
Multi is the default api for methods, it is not necessary to explicitly
decorate methods with it, adds clutter and most people use it because
they see that the rest of the code uses it.

Done with `find . -type f -name '*.py' | xargs sed -i '/@api.multi/d'`
2019-07-17 14:13:12 +02:00
Romain Derie 9813ee4eb8 [IMP] doc: adapt doc to new test asset and JS test file structure
Adapt doc to d7cd97a9b

closes odoo/odoo#33921

Signed-off-by: Jérome Maes (jem) <jem@openerp.com>
2019-06-05 16:04:25 +00:00
Jeremy Kersten a80f1ddcda [FIX] doc: git guidelines, don't use # for task/opw
Use task-#xxx is wrong since it will refer to an unexising or wrong hash
of github.

closes odoo/odoo#33121

Signed-off-by: Jérémy Kersten (jke) <jke@openerp.com>
2019-05-02 15:05:06 +00:00
Thibault Delavallée 273fc4af6e [IMP] guidelines: remove actually wanted PEP8 options
Task-1817988

closes odoo/odoo#28714

Signed-off-by: Thibault Delavallee (tde) <tde@openerp.com>
2019-03-05 08:43:31 +00:00
Thibault Delavallée d256350f34 [IMP] guidelines: improve xml ids naming section
* rewording of XML naming section
* remove the convention of suffixing inherited XML ids
  with `_inherit_my_module, as the information is in the
  complete XML id name (prefixed by module name). This will
  avoid too long XML ids.
* extend convention for the name of groups, views, ...

Task-1817988
2019-03-05 08:41:23 +00:00
Thibault Delavallée 64662cc2a9 [IMP] doc: add guidelines for window actions naming
Rewording of "action" naming section.

Task-1817988
2019-03-05 08:40:37 +00:00
jem-odoo dadec538bc [IMP] doc: rewrite part of module structure and js references guidelines
This commit
 * removes deprecated guidelines for static file and assets struture;
 * fixes some typo and mistakes;
 * correctly links JS guidelines section;
 * adds a running example to ease understanding;
 * adds missing section about security files;
 * adds text blocks for each directory to show directly the
   expected result of each section;
 * perform some rewording;

Thanks to @pedrobaeza for its review.

Task-1817988
2019-03-05 08:38:30 +00:00
Veikko Väätäjä 270171752f [FIX] doc: fix numbered list in guidelines
Fix rst-formating for numbered list under heading "Inherited XML".

closes odoo/odoo#30043
2019-01-08 16:49:10 +00:00
Martin Trigaux 5ccba6c54a [IMP] doc: add guidelines about extandability
If the code is well written from the start, won't get so many hook requests

closes odoo/odoo#27570
2018-10-09 15:24:24 +00:00
mreficent cfaf1f5ac5 [IMP] doc: fields names shouldn't overwrite python methods
The documentation should be an example of good practices

closes odoo/odoo#27262
2018-10-10 06:58:01 +00:00
Adrian Torres a277bfb44a [REM] packaging: drop PyYAML dependency
Commit cf853a785b removed all yml tests
and the yml import engine from Odoo forever, however PyYAML remains a
dependency even though it's not used anymore.

This commit removes any reference to this lib that could be found.

closes odoo/odoo#27563
2018-10-09 12:56:03 +00:00
jem-odoo 40778d883d [IMP] doc: add selection method guideline
Sometime, we need to get selection values from
a method. Here are the guidelines about how
to correctly name method and place it in the
code.
2018-09-25 15:19:30 +02:00
jem-odoo 3c35678ce7 [IMP] doc: adapt guidelines for 12.0
Odoo evolves and its coding guidelines too.
This commit :
 - put some news guidelines, case to take
 into account when making new dev
 - update some guidelines that are difficult
 to applied in the real life
 - remove deprecated stuff (RML report, ...)
 - remove references to old
 api mainly, since all new dev must be done in
 new api

Task #1817988
2018-09-25 15:19:30 +02:00
Sébastien Theys 57676dc7d1 [IMP] doc: remove duplicate line
The same content is already there 2 lines above.
2018-07-17 13:55:25 +02:00
qsm-odoo 16ddf4ae54 [REF] doc: adapt to mention scss instead of less 2018-04-18 15:59:26 +02:00
Géry Debongnie 19946294fa [DOC] doc: update/add documentation on js framework
The state of the JS documentation was quite sad, not updated in a long
time.  With this commit, we rework a lot of the JS doc.  Most notably,
we add a section 'Javascript Cheatsheet' (help on some common
customization tasks) and rewrite the 'Javascript Reference' totally.

Note that the JS reference page also contains a reference on all field
widgets.

This work is just the beginning, it is probably not complete, but at
least we will have a foundation.
2018-04-05 09:22:09 +02:00
Martin Trigaux 18e7f99981 [FIX] doc: correct commit guideline format
Github will automatically close the report is you use the format
Closes #number
No need to a leading #
cf https://help.github.com/articles/closing-issues-using-keywords/

Add the meaning of [I18N] tag

This commit is an example of a violation of the "one commit, one fix" principle
2018-03-16 14:45:04 +01:00
Thibault Delavallée dab7368c43 [IMP] doc: improve wording of guidelines introduction
Purpose of this commit is to clean a bit the wording and to clarify how to
handle guidelines between stable and development versions.
2018-03-13 17:26:29 +01:00
Thibault Delavallée 820926f5ba [IMP] doc: improve guidelines related to Git and commit messages
Purpose of this commit is to explain with more details how to write commit
messages. Content of the Git section is also updated with last decisions
and conventions.
2018-03-13 17:26:29 +01:00
Yenthe V.G f4d08ade92 [FIX] doc: remove reference to old vs new API
There is only one API, long live Odoo's API!

Closes #20928
2017-11-14 16:27:33 +01:00
Christophe Simonis 5ce21c7355 [MERGE] forward port branch saas-16 up to b3d0897f2d 2017-10-02 13:05:17 +02:00
Christophe Simonis b4799d0efb [MERGE] forward port branch 10.0 up to 2821730738 2017-10-02 11:04:54 +02:00
Vailiy Korobatov 77d4999940 [FIX] typo in guidelines file 2017-10-02 09:43:43 +02:00
Olivier Dony f5b7de0e6c [FIX] P3: correct more dict iterable builtins use
Some bits posterior or leftover from fffaf735f5

See also parent commit.
2017-08-20 23:25:54 +02:00
Moisés López ca82c77d48 [IMP] doc: remove <data> tag from xml files
Because now is no longer required

Closes #18144
2017-07-13 17:15:51 +02:00
Patrik Lermon f61dc8451e [IMP] doc: update guidelines.rst
Typo
Closes #14652
2016-12-09 09:29:42 +01:00
Yannick Tivisse 98cb4719db [REM] workflow: Remove workflow engine, documentation and tests 2016-11-23 11:52:39 +01:00
Martin Trigaux 9528024536 [FIX] doc: building correctly autoclass references 2016-10-11 12:09:27 +02:00
Olivier Dony 4339196e52 [IMP] support v10 manifest file naming convention
- As of v10, manifest files should be named `__manifest__.py`
- For backwards-compatibility, __openerp__.py manifest files
  will still be supported for the time being
- Limited refactoring, to add support for the 2 different
  naming conventions
- All textual references to __openerp_.py updated in
  documentation and examples
2016-09-05 11:57:50 +02:00
Jérome Maes dfcbcb02ce [IMP] doc : add python idioms and odoo specific coding guidelines
- add python idioms
- odoo specific guidelines (for ORM, translations, ...) inspired from old guidelines v6.0
- some other best pratices
2016-05-19 14:39:52 +02:00
Jérome Maes b04d6e0ac3 [IMP] doc : expand the coding guidelines
- correct typos
- clarify some points, according to the community comments
- precise the xml notation : record tag vs act_window/menuitem/... tags
- add organization of report, wizard, data/demo, ... (directories and naming conventions)
- new conventions for 'symbols'
- ...

Thanks to @rim-odoo for its grammar extremist review, and @tde-banana-odoo for our long debates about wizard conventions.
2016-05-19 14:39:52 +02:00
Martin Trigaux 842a8e6952 [IMP] doc: add guidelines warning
To prevent huge chunk of modifications for styling reasons (e.g. mass PEP8
commits)
2016-04-26 14:58:31 +02:00
Martin Trigaux eae045949d [IMP] doc: simpler coding: utf-8
According to PEP-263, the -*- is just a variant "using formats recognized by
popular editors".
2016-04-26 14:58:31 +02:00
Martin Trigaux 171f884bdc [FIX] doc: deprecated statusbar_color
Can still be mentionned in documentation but should not be used in example.
2016-04-18 11:47:43 +02:00
Yenthe 1174cd3fd5 [FIX] doc: Improve english
Some rephrasing to slightly improve the docs.
Closes #11652
2016-04-12 13:05:29 +02:00
Xavier Morel 374dacf5e6 [FIX] doc: incorrect role syntax 2015-07-07 16:31:48 +02:00
J Bradshaw 2f7ab001e2 [IMP] doc: grammar and readability
Backport of most of #6827 by J Bradshaw with additional
modifications (and some reverts) during review.

closes #6827
2015-07-07 12:09:21 +02:00
Xavier Morel 95e56a109d [ADD] doc: new theme
Pretty much completely rewritten theme with custom HTML translator and a
few parts of the old theme extracted to their own extensions.

Banner images thought not to be that huge after all, and not worth the
hassle of them living in a different repository.

co-authored with @stefanorigano
2015-07-07 11:22:50 +02:00
Jérome Maes b9977ef5d3 [ADD] doc : odoo official coding guidelines. This is the first version of the guidelines. Discussions and conventions are not frozen. 2015-03-31 17:49:41 +02:00