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

UTL Starter help utility #9

Merged
merged 2 commits into from
Mar 29, 2024
Merged

Conversation

gadorlhiac
Copy link
Collaborator

@gadorlhiac gadorlhiac commented Mar 26, 2024

Description

This PR provides a wrapper script and a first help utility to retrieve help documentation for the package.

Checklist

  • utilities/src/help/task_parameters.py to print out parameter descriptions for a Task.
  • Wrapper utilities/lute_help shell script to call various sub-routines - currently only the task_parameters.py script above.

PR Type:

  • New feature/Enhancement

Address issues:

  • NA

Testing

Usage:

utilities/lute_help -T <Task> [--full_schema]

Will return the parameters (required first) of any Task.

Screenshots

NA

@gadorlhiac gadorlhiac requested a review from valmar March 26, 2024 18:27
Copy link
Contributor

@valmar valmar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was not aware that this was in the work, this is rather cool!

@valmar valmar merged commit 13ad69c into slac-lcls:dev Mar 29, 2024
1 check passed
@gadorlhiac gadorlhiac deleted the UTL/help_utilities branch May 15, 2024 18:26
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