DEV Community

Discussion on: Rust: Assertions in API doc?

Collapse
 
chayimfriedman2 profile image
Chayim Friedman

There is a good reason for that: cargo test checks doctests too. If the method will break, the doctest will panic and the build will break. This is like more unit tests. This also serves as a proof that the documentation is correct, AKA "if it compiles, it works".

Collapse
 
burdettelamar profile image
Burdette Lamar

Interesting. I've done something similar in a Ruby project (don't remember which one -- I'm 79), by having a Rake task that makes the doc by running examples, then including the code and output into the doc.