Skip to content

docs: add CLI documentation for --ignore and --select flags#654

Merged
h-mayorquin merged 6 commits intodevfrom
docs-ignore
Mar 26, 2026
Merged

docs: add CLI documentation for --ignore and --select flags#654
h-mayorquin merged 6 commits intodevfrom
docs-ignore

Conversation

@bendichter
Copy link
Copy Markdown
Contributor

Add new sections to the CLI user guide explaining how to:

  • Skip specific checks using the --ignore flag with single or comma-separated check names
  • Run only specific checks using the --select flag

Include a note about heuristic-based checks that may produce false positives for edge cases like long-running experiments.

fix #645

Add new sections to the CLI user guide explaining how to:
- Skip specific checks using the --ignore flag with single or
  comma-separated check names
- Run only specific checks using the --select flag

Include a note about heuristic-based checks that may produce false
positives for edge cases like long-running experiments.
@bendichter bendichter marked this pull request as ready for review March 25, 2026 13:33
@bendichter bendichter requested a review from h-mayorquin March 25, 2026 13:33
Copy link
Copy Markdown
Collaborator

@h-mayorquin h-mayorquin left a comment

Choose a reason for hiding this comment

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

LGTM.

I think it could be improved by mentioning how to discover test names but this is good as it stands.

@h-mayorquin h-mayorquin merged commit 724ffc1 into dev Mar 26, 2026
13 checks passed
@h-mayorquin h-mayorquin deleted the docs-ignore branch March 26, 2026 17:02
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.

Improve documentation for skipping heuristic based checks

2 participants