Login  Register

Re: Self Documenting Tools

Posted by flywire on Jan 06, 2025; 10:37pm
URL: https://forum.librecad.org/Self-Documenting-Tools-tp5725976p5725985.html

It would be best to refer to the previous discussion I linked about the implementation in LC3.

The scope would be the manual reference section tables (which don't contain any interpretation) ensuring all tools are documented. It's my understanding this is fairly basic contemporary programming. I'm thinking of https://peps.python.org/pep-0257/#what-is-a-docstring

I imagine the process would be to generate a table for each tool category (https://docs.librecad.org/en/2.2.0_a/ref/tools.html) containing Name, Icon, Command, Description. Maybe it could extend to toolbars and widgets. The documentation team could take it from there, and if the process was straightforward, might even be able to add the descriptions to the code with developer guidance.
johnfound wrote
...just proves my rule #2:
"In the software design, every list dreams to become a tree."