From 5c54af1e08c0e4e4998ec9128332e3b02bb40fbf Mon Sep 17 00:00:00 2001 From: Bernd Hahnebach Date: Wed, 18 Sep 2019 22:01:11 +0200 Subject: [PATCH] FEM: small changes in coding conventions --- src/Mod/Fem/coding_conventions.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/Mod/Fem/coding_conventions.md b/src/Mod/Fem/coding_conventions.md index 87900b634e..0786d5be46 100644 --- a/src/Mod/Fem/coding_conventions.md +++ b/src/Mod/Fem/coding_conventions.md @@ -2,7 +2,16 @@ - These coding rules apply to FEM module code only. Other modules or the base system may use different coding rules especially in naming policy of Python. +## Spelling +- Be mindful of spelling. Spell checks are quite often neglected. +- [codespell]((https://github.com/codespell-project/codespell#updating) could be used + +~~~ +codespell -q 2 -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez src/Mod/Fem/ +~~~ + ## Python and C++ +#### Code formatting - All files should have a license header - Unix line endings are preferred - never use mixed line endings on one file @@ -52,11 +61,3 @@ find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --igno ## C++ ### Naming policy - CamelCase names - -## Spelling -- Be mindful of spelling. Spell checks are quite often neglected. -- [codespell]((https://github.com/codespell-project/codespell#updating) could be used - -~~~ -codespell -q 2 -S *.ts -L childs,dof,dum,methode,nd,normaly,uint,vertexes,freez src/Mod/Fem/ -~~~