From ac3d5c96d7b8738f7c60cd2c95fa264ba5ce83eb Mon Sep 17 00:00:00 2001 From: Evie Howard Date: Wed, 22 Jul 2026 11:20:39 +0100 Subject: [PATCH] docs(prover): correct prove() exit code doc comment (#2395) Signed-off-by: Evie Howard Signed-off-by: Evan Lezar --- crates/openshell-prover/src/lib.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/openshell-prover/src/lib.rs b/crates/openshell-prover/src/lib.rs index 226705204..0fb875757 100644 --- a/crates/openshell-prover/src/lib.rs +++ b/crates/openshell-prover/src/lib.rs @@ -26,11 +26,11 @@ use policy::parse_policy; use queries::run_all_queries; use report::{render_compact, render_report}; -/// Run the prover end-to-end and return an exit code. +/// Run the prover end-to-end and return a result containing an exit code. /// -/// - `0` — pass (no critical/high findings, or all accepted) -/// - `1` — fail (critical or high findings present) -/// - `2` — input error +/// - `Ok(0)` — pass (no findings, or all accepted) +/// - `Ok(1)` — fail (one or more unaccepted findings present) +/// - `Err(_)` — input or registry loading error /// /// Binary and API capability registries are embedded at compile time. /// Pass `registry_dir` to override with a custom filesystem registry.