mod-level doc comment for validity check

This commit is contained in:
Ralf Jung 2019-08-30 08:37:02 +02:00
parent 235ee34a15
commit d75723e9fe

View File

@ -1,3 +1,9 @@
//! Check the validity invariant of a given value, and tell the user
//! where in the value it got violated.
//! In const context, this goes even further and tries to approximate const safety.
//! That's useful because it means other passes (e.g. promotion) can rely on `const`s
//! to be const-safe.
use std::fmt::Write;
use std::ops::RangeInclusive;