FEM: coding conventions, add documentation info

2019-09-15 22:41:51 +02:00
parent dae91a4fb2
commit 0aaa43a303
1 changed files with 5 additions and 0 deletions
--- a/src/Mod/Fem/coding_conventions.md
+++ b/src/Mod/Fem/coding_conventions.md
@@ -43,6 +43,11 @@ find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --igno
    - forum topic https://forum.freecadweb.org/viewtopic.php?f=10&t=39110
    - BTW: Console prints need a new line where as print does not need one

+### Documenting
+- Python style is preferred over Doxygen style
+    - see ccx tools module in fem tools package
+    - see forum topic: https://forum.freecadweb.org/viewtopic.php?f=10&t=37094
+

 ## C++
 ### Naming policy