aboutsummaryrefslogtreecommitdiff
path: root/src/testkit.rs
diff options
context:
space:
mode:
authoriximeow <me@iximeow.net>2024-06-23 16:16:45 -0700
committeriximeow <me@iximeow.net>2024-06-23 16:16:45 -0700
commit288f0b64a03fe99a6765298a181dfb4ae41049b5 (patch)
tree807ffd39a052138a6da3c10bf5c1e283778a4184 /src/testkit.rs
parent79c40acd94187145f41de9601a3ad8e1c0e3e11f (diff)
doc comments for the new testkit module
Diffstat (limited to 'src/testkit.rs')
-rw-r--r--src/testkit.rs6
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;