Skip to content

Commit b994aba

Browse files
committed
Add explanation of Rustdoc comments
1 parent ee34bc3 commit b994aba

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,13 @@ section below for details on how to run them all.
8888

8989
## Example
9090

91+
The following example shows how to create and verify a 32-bit rangeproof.
92+
9193
```rust
94+
# // The #-commented lines are hidden in Rustdoc but not in raw
95+
# // markdown rendering, and contain boilerplate code so that the
96+
# // code in the README.md is actually run as part of the test suite.
97+
#
9298
# extern crate rand;
9399
# use rand::thread_rng;
94100
#
@@ -142,8 +148,8 @@ assert!(
142148

143149
## Tests and Benchmarks
144150

145-
Run tests with `cargo test`.
146-
Run benchmarks with `cargo bench`. This crate uses [criterion.rs][criterion] for benchmarks.
151+
Run tests with `cargo test`. Run benchmarks with `cargo bench`. This crate
152+
uses [criterion.rs][criterion] for benchmarks.
147153

148154
## Features
149155

0 commit comments

Comments
 (0)