From 81029f594dbe07bd60d8597a4efb5628ae5d7283 Mon Sep 17 00:00:00 2001 From: bashbunni Date: Tue, 6 Aug 2024 15:41:49 -0700 Subject: [PATCH] docs(godoc): replace list mentions in tree package --- tree/children.go | 6 +++--- tree/tree.go | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/tree/children.go b/tree/children.go index 9cd4db8e..6727092a 100644 --- a/tree/children.go +++ b/tree/children.go @@ -1,11 +1,11 @@ package tree -// Children is the interface that wraps the basic methods of a list model. +// Children is the interface that wraps the basic methods of a tree model. type Children interface { // At returns the content item of the given index. At(index int) Node - // Length returns the number of items in the list. + // Length returns the number of children in the tree. Length() int } @@ -86,7 +86,7 @@ func (m *Filter) Filter(f func(index int) bool) *Filter { return m } -// Length returns the number of items in the list. +// Length returns the number of children in the tree. func (m *Filter) Length() int { j := 0 for i := 0; i < m.data.Length(); i++ { diff --git a/tree/tree.go b/tree/tree.go index 63bca3ea..94f5dd08 100644 --- a/tree/tree.go +++ b/tree/tree.go @@ -255,12 +255,12 @@ func (t *Tree) ItemStyleFunc(fn StyleFunc) *Tree { return t } -// Enumerator sets the enumerator implementation. This can be used to change the way the branches indicators look. -// Lipgloss includes predefined enumerators including bullets, roman numerals, and more. For -// example, you can have a numbered list: +// Enumerator sets the enumerator implementation. This can be used to change the +// way the branches indicators look. Lipgloss includes predefined enumerators +// for a classic or rounded tree. For example, you can have a rounded tree: // // tree.New(). -// Enumerator(Arabic) +// Enumerator(RoundedEnumerator) func (t *Tree) Enumerator(enum Enumerator) *Tree { t.ensureRenderer().enumerator = enum return t