summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoriximeow <me@iximeow.net>2022-01-21 18:37:25 -0800
committeriximeow <me@iximeow.net>2022-01-21 18:37:25 -0800
commit67a65b8b85bfa27c22e4421b4730b0ae75af028e (patch)
tree599587e1f919639721977085a92574d6a1c075d9
parent35222d0f9f33e86a6046fad1f0d6a7e09656016b (diff)
one last docs note and we're off1.0.0no-gods-no-
-rw-r--r--src/lib.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 39cab9a..b8fe11c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -71,7 +71,9 @@
//!
//! additionally, `yaxpeax-nd812` implements `yaxpeax-arch` traits for generic use, such as
//! [`yaxpeax_arch::LengthedInstruction`]. [`yaxpeax_arch::Arch`] is implemented by
-//! the unit struct [`ND812`].
+//! the unit struct [`ND812`]. `yaxpeax-nd812` does not decode from a `U8Reader`, like many other
+//! decodes, but does decode from an `ND812Reader` that can be trivially constructed from a
+//! `U8Reader`.
//!
//! ## `#![no_std]`
//!