Make plugin creation documentation language more precise
Stratus3D opened this issue · 0 comments
Stratus3D commented
How can we improve the documentation?
On #1445 I noted a number of small things that could be changed to make the plugin creation documentation more precise. Enumerating them:
- Update the document so that it is clear "plugin scripts" are specifically callbacks that will be invoked at the right time by asdf. It might be good to emphasizing this somewhere here at the top of the document for clarity. These are "callback scripts invoked by asdf when needed".
- "The full list of Environment Variables used throughout all scripts." seems at odds with "Not all environment variables are available in all scripts.". Reword or combine these lines for clarity
- Update the doc so the word "parameters" is used represent values a script or function accepts as input, and "arguments" for values that get passed to a script or function when it's invoked. See https://stackoverflow.com/questions/156767/whats-the-difference-between-an-argument-and-a-parameter