Skip to content

Commit

Permalink
fix(cli): add range specs to --jobs' help message.
Browse files Browse the repository at this point in the history
Add an indication on how to specify ranges in the help message of the
`--jobs` (`-j`) option of the `gridtk list` command.
  • Loading branch information
Yannick-Dayer committed Jul 23, 2024
1 parent b4cf63a commit 8dbf3ff
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/gridtk/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,12 @@ def _job_filters_decorator(function):
"-j",
"--jobs",
"job_ids",
help="Selects only these job ids, separated by comma.", # TODO: explain range notation
help=(
"Selects only these job ids, separated by comma. A range can also be "
"specified in the form 'start-end' ('-j 3-5' is equivalent to "
"'-j 3,4,5') or in the form 'start+length' ('-j 4+3' is equivalent to "
"'-j 4,5,6,7')."
),
callback=job_ids_callback,
)(function)
function = click.option(
Expand Down

0 comments on commit 8dbf3ff

Please sign in to comment.