Skip to content

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

Merged
merged 5 commits into from
Jun 11, 2025
Merged

Add more info to cli help #802

merged 5 commits into from
Jun 11, 2025

Conversation

rcannood
Copy link
Member

@rcannood rcannood commented Mar 3, 2025

Describe your changes

This PR adds more info to the CLI help.

Type of Change

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • New functionality (non-breaking change which adds functionality)
  • Major change (non-breaking change which modifies existing functionality)
  • Minor change (non-breaking change which does not modify existing functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

Checklist

Requirements:

  • I have read the CONTRIBUTING doc.
  • I have performed a self-review of my code by checking the "Changed Files" tab.
  • My code follows the code style of this project.

Tests:

  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

Documentation:

  • Proposed changes are described in the CHANGELOG.md.
  • I have updated the documentation accordingly.

Test Environment

@rcannood rcannood requested a review from Grifs March 3, 2025 09:35
Copy link
Collaborator

@Grifs Grifs left a 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.

Comment on lines 738 to 739
| $VIASH_TEMP
| The temporary directory to use. This will be passed to the component via `meta["temp_dir"]`.
Copy link
Collaborator

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?

Copy link
Member Author

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?

@rcannood
Copy link
Member Author

rcannood commented Mar 4, 2025

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.

That's also true. Maybe I'll get rid of the additional information, but do add some docs about VIASH_TEMP?

@rcannood rcannood requested a review from Grifs March 21, 2025 08:41
@rcannood rcannood merged commit b611d1b into develop Jun 11, 2025
7 checks passed
@rcannood rcannood deleted the add_more_info branch June 11, 2025 15:58
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

Successfully merging this pull request may close these issues.

2 participants