FEM: coding convetionts, print vs. console print

This commit is contained in:
Bernd Hahnebach
2019-09-13 08:06:58 +02:00
parent 78c2d33a47
commit 982a1bb4cb

View File

@@ -1,6 +1,7 @@
# FEM coding_conventions
- 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.
## Python and C++
- All files should have a license header
- Unix line endings are preferred
@@ -8,6 +9,7 @@
- 4 Spaces for indent
- no trailing white spaces
## Python
#### Code formatting
- except W503 all Python code is pep8 compliant
@@ -34,6 +36,14 @@ find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --igno
- automatic code formatter will not be used for existent code
- for new code if someone would like to use a code formatter black should be used
### Coding
- print() vs. FreeCAD.Console.PrintMessage()
- FreeCAD.Console.PrintMessage() or Log or Error should be used
- print() should be used for debugging only
- 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
## C++
### Naming policy
- CamelCase names