Codebase list golang-github-vbauerster-mpb / 8e0397e decor / doc.go
8e0397e

Tree @8e0397e (Download .tar.gz)

doc.go @8e0397e — raw · history · blame 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
// Package decor provides common decorators for "github.com/vbauerster/mpb/v8" module.
//
// Some decorators returned by this package might have a closure state. It is ok to use
// decorators concurrently, unless you share the same decorator among multiple
// *mpb.Bar instances. To avoid data races, create new decorator per *mpb.Bar instance.
//
// Don't:
//
//	 p := mpb.New()
//	 name := decor.Name("bar")
//	 p.AddBar(100, mpb.AppendDecorators(name))
//	 p.AddBar(100, mpb.AppendDecorators(name))
//
// Do:
//
//	p := mpb.New()
//	p.AddBar(100, mpb.AppendDecorators(decor.Name("bar1")))
//	p.AddBar(100, mpb.AppendDecorators(decor.Name("bar2")))
package decor