Annotate low-level scripting actions in various stores with JSDoc #1482
Labels
code maintenance
For issues relating to code maintenance and quality
enhancement
New feature or request
Based on request in CARTAvis/carta#78 from @keflavich.
We need to have some form of documentation for the low-level scripting actions that are available. This will allow users to either utilise the debug execution feature on the frontend, or extend the high-level Python scripting interface.
I suggest we use JSDoc for this, as we can embed the documentation in the code and generate an API document in HTML reasonably easily.
As an example, the angus/jsdoc branch has the following for
appendFile
:If we can document these functions well, and also extend the debug execution dialog into something more akin to a full scripting console, CARTA would become very extensible.
The text was updated successfully, but these errors were encountered: