diff --git a/src/Mod/Fem/coding_conventions.md b/src/Mod/Fem/coding_conventions.md index 0f14f7a5d7..b700ecdf63 100644 --- a/src/Mod/Fem/coding_conventions.md +++ b/src/Mod/Fem/coding_conventions.md @@ -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