From dab97de401ea6734bfaca64d256bb6cfadf3cbe0 Mon Sep 17 00:00:00 2001 From: Jack O'Connor Date: Sun, 28 Mar 2021 15:12:42 -0400 Subject: update doc comments on guts module --- src/guts.rs | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) (limited to 'src') diff --git a/src/guts.rs b/src/guts.rs index 88dcc86..e06721c 100644 --- a/src/guts.rs +++ b/src/guts.rs @@ -1,7 +1,10 @@ -// This module is for incremental use cases like the `bao` crate, which need to -// get their hands on internal chunk and parent chaining values. The vast -// majority of users should ignore this and use the publicly documented -// interface instead. +//! This undocumented and unstable module is for use cases like the `bao` crate, +//! which need to traverse the BLAKE3 Merkle tree and work with chunk and parent +//! chaining values directly. There might be breaking changes to this module +//! between patch versions. +//! +//! We could stabilize something like this module in the future. If you have a +//! use case for it, please let us know by filing a GitHub issue. #[derive(Clone, Debug)] pub struct ChunkState(crate::ChunkState); -- cgit v1.2.3