diff --git a/bar_filler.go b/bar_filler.go index a0707ce..00bf0a4 100644 --- a/bar_filler.go +++ b/bar_filler.go @@ -18,7 +18,8 @@ rRefill ) -// DefaultBarStyle is applied when bar constructed with *Progress.AddBar method. +// DefaultBarStyle is a string containing 7 runes. +// Each rune is a building block of a progress bar. // // '1st rune' stands for left boundary rune // @@ -44,7 +45,7 @@ flush func(w io.Writer, bb [][]byte) } -// NewBarFiller constucts mpb.Filler, to be used with *Progress.Add method. +// NewBarFiller constucts mpb.BarFiller, to be used with *Progress.Add(...) *Bar method. func NewBarFiller(style string, reverse bool) BarFiller { if style == "" { style = DefaultBarStyle diff --git a/spinner_filler.go b/spinner_filler.go index cc30151..517725f 100644 --- a/spinner_filler.go +++ b/spinner_filler.go @@ -18,7 +18,7 @@ SpinnerOnRight ) -// DefaultSpinnerStyle is applied when bar constructed with *Progress.AddSpinner method. +// DefaultSpinnerStyle is a slice of strings, which makes a spinner. var DefaultSpinnerStyle = []string{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"} type spinnerFiller struct { @@ -27,7 +27,7 @@ alignment SpinnerAlignment } -// NewSpinnerFiller constucts mpb.Filler, to be used with *Progress.Add method. +// NewSpinnerFiller constucts mpb.BarFiller, to be used with *Progress.Add(...) *Bar method. func NewSpinnerFiller(style []string, alignment SpinnerAlignment) BarFiller { if len(style) == 0 { style = DefaultSpinnerStyle