Skip to content

Commit edb618a

Browse files
committed
docs(cli): 📝 rephrase --skip-checks option description
1 parent 36e80af commit edb618a

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

rocrate_validator/cli/commands/validate.py

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -201,13 +201,14 @@ def get_single_char(console: Optional[Console] = None, end: str = "\n",
201201
show_default=True,
202202
metavar="Fully-Qualified-Check-IDs",
203203
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]."
204+
"[bold yellow]Fully-Qualified-Check-IDs[/bold yellow] is a comma-separated list of checks to skip "
205+
"(may be specified multiple times). Each check must be specified by its "
206+
"Fully Qualified Identifier, e.g., [bold cyan]ro-crate-1.1_12.1[/bold cyan]. The fully qualified "
207+
"check identifier has the format <Profile-ID>_<Requirement_#>.<RequirementCheck_#>, "
208+
"where <Requirement_#> is the position number of the Requirement in the profile, "
209+
"and <RequirementCheck_#> is the position number of the RequirementCheck within that Requirement. "
210+
"You can find the Fully-Qualified-Check IDs using: "
211+
"[bold orange1]rocrate-validator profiles describe <Profile-ID> -v[/bold orange1]"
211212
),
212213
)
213214
@click.option(

0 commit comments

Comments
 (0)