kindred/create
1
1
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

FEM: extend coding conventions

Browse Source
This commit is contained in:
Bernd Hahnebach
2020-03-14 11:18:33 +01:00
parent cbee07d53a
commit 817eb41aef
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/Mod/Fem/coding_conventions.md
View File

@@ -86,11 +86,16 @@ find src/Mod/Fem/ -name "*\.py" | grep -v InitGui.py | xargs -I [] flake8 --igno
- do not use hasattr(obj, "Proxy") and obj.Proxy.Type
- use method is_of_typ(obj, "TypeString") from module femtool.femutils
- ActiveDocument
- do not use App.ActiveDocument or FreeCAD.ActiveDocument, if possible
- use some_obj.Document instead
- do not use Gui.ActiveDocument or FreeCADGui.ActiveDocument, if possible
- use some_obj.ViewObject.Document or some_view_obj.Document
- try to avoid the use of App.ActiveDocument or FreeCAD.ActiveDocument
- instead try to use some_obj.Document instead
- try to avoid the use of Gui.ActiveDocument or FreeCADGui.ActiveDocument
- instead try to use some_obj.ViewObject.Document or some_view_obj.Document
- activeDocument() is more robust than ActiveDocument
- [forum topic](https://forum.freecadweb.org/viewtopic.php?f=10&t=44133)
- FreeCAD Python console
- in code examples which will be copied in FreeCAD Python console
- it is common to use App.ActiveDocument.some_obj or method
### Documenting
Python style is preferred over Doxygen style
- see `ccx` tools module in fem tools package