Skip to content

Commit 4e43f69

Browse files
authored
Small adjustments to our doc / help (rust-lang#1153)
* Remove redundant check from README.md In the example, we were calling is_valid after `kani::any()` which is redundant since the type has to implement the Arbitrary type. * Also adjust Kani help
1 parent f2d9efb commit 4e43f69

File tree

2 files changed

+2
-5
lines changed

2 files changed

+2
-5
lines changed

README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,13 @@ See [the installation guide](https://model-checking.github.io/kani/install-guide
2525
Similar to testing, you write a harness, but with Kani you can check all possible values using `kani::any()`:
2626

2727
```rust
28-
use my_crate::{function_under_test, is_valid, meets_specification};
28+
use my_crate::{function_under_test, meets_specification};
2929

3030
#[kani::proof]
3131
fn check_my_property() {
3232
// Create a nondeterministic input
3333
let input = kani::any();
3434

35-
// Constrain it to represent valid values
36-
kani::assume(is_valid(input));
37-
3835
// Call the function under verification
3936
let output = function_under_test(input);
4037

kani-driver/src/args.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const DEFAULT_OBJECT_BITS: u32 = 16;
1313
#[derive(Debug, StructOpt)]
1414
#[structopt(
1515
name = "kani",
16-
about = "Verify a single Rust file. For more information, see https://github.com/model-checking/kani",
16+
about = "Verify a single Rust crate. For more information, see https://github.com/model-checking/kani",
1717
setting = structopt::clap::AppSettings::AllArgsOverrideSelf
1818
)]
1919
pub struct StandaloneArgs {

0 commit comments

Comments
 (0)