Fix docs and doc-tests

rerun-io · Nov 21, 2023 · a06e813 · a06e813
1 parent 4e1542a
commit a06e813
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/src/tiles.rs b/src/tiles.rs
@@ -16,7 +16,7 @@ use super::{
 /// let tabs: Vec<TileId> = vec![tiles.insert_pane(Pane { }), tiles.insert_pane(Pane { })];
 /// let root: TileId = tiles.insert_tab_tile(tabs);
 ///
-/// let tree = Tree::new(root, tiles);
+/// let tree = Tree::new("my_tree", root, tiles);
 /// ```
 #[derive(Clone, Debug)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]

diff --git a/src/tree.rs b/src/tree.rs
@@ -23,7 +23,7 @@ use super::{
 /// let tabs: Vec<TileId> = vec![tiles.insert_pane(Pane { }), tiles.insert_pane(Pane { })];
 /// let root: TileId = tiles.insert_tab_tile(tabs);
 ///
-/// let tree = Tree::new(root, tiles);
+/// let tree = Tree::new("my_tree", root, tiles);
 /// ```
 #[derive(Clone, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
@@ -95,6 +95,8 @@ impl<Pane> Tree<Pane> {
 
     /// The most flexible constructor, allowing you to set up the tiles
     /// however you want.
+    ///
+    /// The `id` must be _globally_ unique (!).
     pub fn new(id: impl Into<egui::Id>, root: TileId, tiles: Tiles<Pane>) -> Self {
         Self {
             root: Some(root),