Skip to content

Commit

Permalink
Small doc fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Filippo Costa <filippo@neysofu.me>
  • Loading branch information
neysofu committed Aug 27, 2023
1 parent 218b986 commit 09b1477
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ pub enum IteratorError {
FusedIteratorReturnedSomeAfterExhaustion,
}

/// Represents a broken invariant of a tested trait implementation.
/// The crate error type.
#[derive(Error, Debug, Clone)]
#[non_exhaustive]
pub enum Error {
Expand Down
5 changes: 4 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
//! implementing. For example, if you implement [`PartialEq`] for `Foo`, you must
//! guarantee that `foo1 == foo2` implies `foo2 == foo1` (*symmetry*).
//!
//! Other traits such as [`Hash`] and [`Iterator`] mandate several invariants as
//! Other traits such as [`Hash`] and [`Iterator`] mandate their own invariants as
//! well – some of which are very intuitive, and
//! [others](https://doc.rust-lang.org/std/hash/trait.Hash.html#prefix-collisions)
//! which are not. It's especially common for less-than-perfect implementations
Expand Down Expand Up @@ -51,6 +51,9 @@
//! type. This is because it takes up to three values to test some
//! invariants.
//!
//! The [`reltester::invariants`](invariants) module is available for more
//! granular checks if you can't satisfy the type bounds of the main functions.
//!
//! ## Multi-type relations: `Foo: PartialEq<Bar>` and `Foo: PartialOrd<Bar>`
//!
//! In some cases your [`PartialEq`] and [`PartialOrd`] implementations
Expand Down

0 comments on commit 09b1477

Please sign in to comment.