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

Be Exceedingly Clear and Explicit in Documenting Parameters #103

Open
dwlehman opened this issue Jun 10, 2020 · 1 comment
Open

Be Exceedingly Clear and Explicit in Documenting Parameters #103

dwlehman opened this issue Jun 10, 2020 · 1 comment

Comments

@dwlehman
Copy link
Collaborator

Make sure to include data type, acceptable values, examples, default values, and whether each parameter is required or optional.

Also add a separate statement describing the minimum information for a pool or volume.

@dwlehman
Copy link
Collaborator Author

Also, document the version each parameter was introduced.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant