Kunda1 wrote: ↑
Thu Jan 09, 2020 4:56 pm
Thinking of using the WikiRobots
bot to test if a FC command documentation page does or doesn't have a Scripting section.
This is fine.
Just a word of caution for editors. I originally started adding "Scripting" sections to GUI commands following the example of the Draft Workbench
, which had those sections already. The way this workbench is written, it makes total sense, but this may not be the case for other workbenches.
The idea is to provide a basic script that teaches users to work with a particular tool quickly. It is not meant to be extensive or the full programming documentation (API).
Further documentation should be generated automatically by Doxygen
, by parsing the documentation strings in the case of purely Python-based commands. For C++ commands, often a there is no easy way to generate user documentation, so a basic scripting section is necessary.
Moreover, we should distinguish between a GUI-less function and a GUI command (button). Almost every GUI command in Draft has a corresponding GUI-less function. So the GUI-less function is what is described in the Scripting section. For other workbenches this may not be the case because they only have GUI commands (buttons) but no GUI-less functions.
Said in another way, just because a GUI tool lacks a "Scripting" section, that doesn't mean the documentation is incomplete. Almost everything can be done in the Python console
but maybe some tools are inherently graphical and don't require a "Scripting" section.