Update docstring for SumTree (#10927)

Need the updated docstring for the blog post.
Release Notes:

- N/A
This commit is contained in:
Thorsten Ball 2024-04-24 14:01:10 +02:00 committed by GitHub
parent 6108140a02
commit f7ea1370a4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -151,8 +151,10 @@ impl Bias {
}
}
/// A B-tree where each leaf node contains an [`Item`] of type `T`,
/// and each internal node contains a [`Summary`] of the items in its subtree.
/// A B+ tree in which each leaf node contains `Item`s of type `T` and a `Summary`s for each `Item`.
/// Each internal node contains a `Summary` of the items in its subtree.
///
/// The maximum number of items per node is `TREE_BASE * 2`.
///
/// Any [`Dimension`] supported by the [`Summary`] type can be used to seek to a specific location in the tree.
#[derive(Debug, Clone)]