From 9c61290a6b317eae2835c374ed019448be0d0c64 Mon Sep 17 00:00:00 2001 From: xibeiyoumian Date: Mon, 22 Dec 2025 15:45:56 +0800 Subject: [PATCH] chore: improve code comments clarity Signed-off-by: xibeiyoumian --- src/lib.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index f100396..930647d 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,7 +9,7 @@ use std::collections::VecDeque; use std::fmt::{self, Display}; use std::rc::Rc; -/// a simple recursive type which is able to render its +/// A simple recursive type which is able to render its /// components in a tree-like format #[derive(Debug, Clone)] pub struct Tree { @@ -48,7 +48,7 @@ impl Tree { } impl Tree { - /// Ensure all lines for `root` are indented + /// Set whether all lines for `root` should be indented pub fn set_multiline(&mut self, yes: bool) -> &mut Self { self.multiline = yes; self @@ -90,7 +90,7 @@ impl Display for Tree { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.root.fmt(f)?; // Pass along `f.alternate()` writeln!(f)?; - let mut queue = DisplauQueue::new(); + let mut queue = DisplayQueue::new(); let no_space = Rc::new(Vec::new()); let default_glyphs = GlyphPalette::new(); let glyphs = self.glyphs.as_ref().unwrap_or(&default_glyphs); @@ -163,10 +163,10 @@ impl Display for Tree { } } -type DisplauQueue<'t, D> = VecDeque<(bool, &'t Tree, &'t GlyphPalette, Rc>)>; +type DisplayQueue<'t, D> = VecDeque<(bool, &'t Tree, &'t GlyphPalette, Rc>)>; fn enqueue_leaves<'t, D: Display>( - queue: &mut DisplauQueue<'t, D>, + queue: &mut DisplayQueue<'t, D>, parent: &'t Tree, parent_glyphs: &'t GlyphPalette, spaces: Rc>,