Skip to content

Commit

Permalink
docs: add extra explanation for OptionSetMaxDetailRow. The param must…
Browse files Browse the repository at this point in the history
… be calculated by developer prudently.
  • Loading branch information
chengxilo committed Aug 28, 2024
1 parent a829eb6 commit a723f49
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions progressbar.go
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,7 @@ func OptionShowDescriptionAtLineEnd() Option {
}

// OptionSetMaxDetailRow sets the max row of details
// the row count should be less than the terminal height, otherwise it will not give you the output you want
func OptionSetMaxDetailRow(row int) Option {
return func(p *ProgressBar) {
p.config.maxDetailRow = row
Expand Down

0 comments on commit a723f49

Please sign in to comment.