From 10e4b7592274edcaee7c4011bb669e17b970cfc8 Mon Sep 17 00:00:00 2001 From: Lynn Date: Mon, 5 Dec 2022 17:55:35 +0100 Subject: [PATCH] Explain what the crate does in lib.rs docs Currently https://docs.rs/quickcheck doesn't say much about what this crate does. I think having most info in the README is OK, but probably there should be some info in the crate docs root as well. --- src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 58dc99d..d3a5ba4 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -2,6 +2,11 @@ This crate is a port of [Haskell's QuickCheck](https://hackage.haskell.org/package/QuickCheck). +QuickCheck is a library for random testing of program properties. The +programmer provides a specification of the program, in the form of properties +which functions should satisfy, and QuickCheck then tests that the properties +hold in a large number of randomly generated cases. + For detailed examples, please see the [README](https://github.com/BurntSushi/quickcheck).