Join the club. The internals of FreeCAD have a ton of functionality but often nobody has documented them in a proper way. You essentially have to dig through the C++ code to see what else is available.Kunda1 wrote: ↑Sat Mar 07, 2020 12:02 am ...
Edit: Also found in the code: https://github.com/FreeCAD/FreeCAD/blob ... and.h#L592
...
How could we annotate it better so it's clear while studying the API what it does. Is it just me or does that seem super generic and nondescript?
The proper way to document this is to see it in practice. The src/Mod/TemplatePyMod directory defines a workbench that is not installed but which has some example commands. This should be cleaned up and updated. Essentially, the developer documentation in the Power users hub is based on these examples. What would be ideal is to create a complete "example workbench" with many fake objects and Gui commands which can be used to demonstrate many things. And obviously, this workbench should be described fully in the wiki.