doc comments for the new testkit module

1 files changed, 6 insertions, 0 deletions

diff --git a/src/testkit.rs b/src/testkit.rs
index 1018234..6600d80 100644
--- a/src/testkit.rs
+++ b/src/testkit.rs
@@ -1,2 +1,8 @@
+//! utilities to validate that implementations of traits in `yaxpeax-arch` uphold requirements
+//! described in this crate.
+//!
+//! currently, this only includes tools to validate correct use of
+//! [`yaxpeax_arch::display::DisplaySink`], but may grow in the future.
+
 #[cfg(feature="alloc")]
 pub mod display;