-
Notifications
You must be signed in to change notification settings - Fork 5
Add more info to cli help #802
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see that this would be useful for the developer of a component, but it might be confusing for the person who has to run the components.
Some minor remarks added too.
| $VIASH_TEMP | ||
| The temporary directory to use. This will be passed to the component via `meta["temp_dir"]`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the right section to document environment variable usage?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well at the moment we don't document environment variables at all. But perhaps it should be listed as a separate section. Do you think that's better?
That's also true. Maybe I'll get rid of the additional information, but do add some docs about VIASH_TEMP? |
Describe your changes
This PR adds more info to the CLI help.
Type of Change
Checklist
Requirements:
Tests:
Documentation:
Test Environment