Skip to content

Commit 9ced403

Browse files
committed
docs: Correct default-unwind Cargo.toml examples
The examples for configuring `default-unwind` inside Cargo.toml files use unquoted integers. This isn't how they are actually expected to be written, and following these examples leads to kani failing to run. This corrects the examples in the documentation to align with the expected configuration format. Signed-off-by: hashcatHitman <[email protected]>
1 parent 6b4637f commit 9ced403

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/src/tutorial-loop-unwinding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ You can do this by putting this into your `Cargo.toml` file:
112112

113113
```toml
114114
[workspace.metadata.kani.flags]
115-
default-unwind = 1
115+
default-unwind = "1"
116116
```
117117

118118
## Bounded proof

docs/src/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ For example, if you want to set a default loop unwinding bound (when it's not ot
6161

6262
```toml
6363
[package.metadata.kani.flags]
64-
default-unwind = 1
64+
default-unwind = "1"
6565
```
6666

6767
The options here are the same as on the command line (`cargo kani --help`), and flags (that is, command line arguments that don't take a value) are enabled by setting them to `true`.

0 commit comments

Comments
 (0)