Skip to content

Commit

Permalink
add file comment for partial example
Browse files Browse the repository at this point in the history
  • Loading branch information
tistatos committed Nov 4, 2024
1 parent b2d4f8b commit 3290b81
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions examples/custom_tree_owned_partial.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
//! ## Example: Partial Tree with Directly Owned Children
//!
//! The following example demonstrate an implementation of Taffy's Partial trait and usage of the low-level compute APIs.
//! This example uses directly owned children with NodeId's being index's into vec on parent node.
//! Since an iterator created from a node can't access grandchildren, we are limited to only implement `TraversePartialTree`.
//! See the [`crate::tree::traits`] module for more details about the low-level traits.

mod common {
pub mod image;
pub mod text;
Expand Down

0 comments on commit 3290b81

Please sign in to comment.