Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make plugin creation documentation language more precise #1595

Open
Stratus3D opened this issue Jul 12, 2023 · 0 comments
Open

Make plugin creation documentation language more precise #1595

Stratus3D opened this issue Jul 12, 2023 · 0 comments

Comments

@Stratus3D
Copy link
Member

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant