Skip to content

docs(prover): correct prove() exit code doc comment#2395

Open
eviehoward wants to merge 1 commit into
NVIDIA:mainfrom
eviehoward:2394-fix-prover-exit-code-doc/eviehoward
Open

docs(prover): correct prove() exit code doc comment#2395
eviehoward wants to merge 1 commit into
NVIDIA:mainfrom
eviehoward:2394-fix-prover-exit-code-doc/eviehoward

Conversation

@eviehoward

Copy link
Copy Markdown

Summary

Corrects the prove() doc comment which incorrectly described exit code 1 as
firing on "critical or high findings." The prover has no severity grades — exit
code 1 fires on any unaccepted finding.

Related Issue

Closes #2394

Changes

  • Corrected exit code descriptions in crates/openshell-prover/src/lib.rs:31-32

Testing

  • mise run pre-commit passes
  • Unit tests added/updated — not applicable, doc comment only
  • E2E tests added/updated — not applicable

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated — not applicable

Signed-off-by: Evie Howard <evhoward@redhat.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 21, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown

All contributors have signed the DCO ✍️ ✅
Posted by the DCO Assistant Lite bot.

@eviehoward

Copy link
Copy Markdown
Author

I have read the DCO document and I hereby sign the DCO.

@matthewgrossman

Copy link
Copy Markdown
Contributor

recheck

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.

bug(prover): prove() doc comment incorrectly references severity grades

2 participants