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

Add -h flag to apps #17

Closed
arisp99 opened this issue Nov 4, 2021 · 0 comments
Closed

Add -h flag to apps #17

arisp99 opened this issue Nov 4, 2021 · 0 comments
Assignees
Labels
documentation 📑 documentation issue or improvement
Milestone

Comments

@arisp99
Copy link
Member

arisp99 commented Nov 4, 2021

In an effort to improve docs, we should add the -h flag to all the MIPTools apps. Then the user can type the flag and get a nicely formatted man page. An example format that we could use is below:

Description

Usage:
singularity run [options] --app [app_options]

Options:
See 'singularity run'.

App Options:
-a Required. Description
-b Optional argument. Default value.
-h Print the help page.

Examples:
# Set paths
$ resource_dir=/bin/MIPTools/base_resources
$ dir=/work/usr/example

# Run app
$ singularity run
-B $resource_dir:/opt/resources -B $dir:/opt/analysis
--app -h

@arisp99 arisp99 added the documentation 📑 documentation issue or improvement label Nov 4, 2021
@arisp99 arisp99 added this to the 1.0.0 milestone Nov 4, 2021
@arisp99 arisp99 self-assigned this Nov 4, 2021
arisp99 added a commit that referenced this issue Nov 4, 2021
Part of the effort in #17
arisp99 added a commit that referenced this issue Nov 4, 2021
Part of the effort in #17
arisp99 added a commit that referenced this issue Nov 4, 2021
Part of the effort in #17
arisp99 added a commit that referenced this issue Nov 6, 2021
Part of the effort in #17
@arisp99 arisp99 closed this as completed in 600121f Nov 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📑 documentation issue or improvement
Projects
None yet
Development

No branches or pull requests

1 participant