From 288f0b64a03fe99a6765298a181dfb4ae41049b5 Mon Sep 17 00:00:00 2001 From: iximeow Date: Sun, 23 Jun 2024 16:16:45 -0700 Subject: doc comments for the new testkit module --- src/testkit.rs | 6 ++++++ 1 file changed, 6 insertions(+) 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; -- cgit v1.1