Skip to content

Commit 761f54a

Browse files
eviehowardelezar
authored andcommitted
docs(prover): correct prove() exit code doc comment
Signed-off-by: Evie Howard <[email protected]> Signed-off-by: Evan Lezar <[email protected]>
1 parent 8d9502d commit 761f54a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • crates/openshell-prover/src

‎crates/openshell-prover/src/lib.rs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ use policy::parse_policy;
2626
use queries::run_all_queries;
2727
use report::{render_compact, render_report};
2828

29-
/// Run the prover end-to-end and return an exit code.
29+
/// Run the prover end-to-end and return a result containing an exit code.
3030
///
31-
/// - `0` — pass (no critical/high findings, or all accepted)
32-
/// - `1` — fail (critical or high findings present)
33-
/// - `2` — input error
31+
/// - `Ok(0)` — pass (no findings, or all accepted)
32+
/// - `Ok(1)` — fail (one or more unaccepted findings present)
33+
/// - `Err(_)` — input or registry loading error
3434
///
3535
/// Binary and API capability registries are embedded at compile time.
3636
/// Pass `registry_dir` to override with a custom filesystem registry.

0 commit comments

Comments
 (0)