Skip to content

Commit 513506c

Browse files
committed
docs(cli): 📝 improve description of the skip-checks option
1 parent 0026948 commit 513506c

1 file changed

Lines changed: 11 additions & 1 deletion

File tree

rocrate_validator/cli/commands/validate.py

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ def get_single_char(console: Optional[Console] = None, end: str = "\n",
157157
type=click.STRING,
158158
default=None,
159159
show_default=True,
160+
metavar="Profile-ID",
160161
help="Identifier of the profile to use for validation",
161162
)
162163
@click.option(
@@ -198,7 +199,16 @@ def get_single_char(console: Optional[Console] = None, end: str = "\n",
198199
type=click.STRING,
199200
default=None,
200201
show_default=True,
201-
help="List of checks to skip"
202+
metavar="Fully-Qualified-Check-IDs",
203+
help=(
204+
"[bold yellow]Fully-Qualified-Check-IDs[/bold yellow] "
205+
"is a [italic]comma-separated list[/italic] of checks to skip "
206+
"(can be specified multiple times). "
207+
"Each check must be given by its [bold yellow]Fully Qualified Identifier[/bold yellow], "
208+
"e.g., [bold cyan]ro-crate-1.1_12.1[/bold cyan]. "
209+
"The fully qualified check identifier has the format <Profile-ID>.<Requirement-ID>.<Check-ID> "
210+
"and can be found using: [orange1]rocrate-validator profiles describe <Profile-ID> -v[/orange1]."
211+
),
202212
)
203213
@click.option(
204214
'-v',

0 commit comments

Comments
 (0)