diff options
Diffstat (limited to 'vendor/github.com/vbauerster/mpb/v5/decor/doc.go')
-rw-r--r-- | vendor/github.com/vbauerster/mpb/v5/decor/doc.go | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/vendor/github.com/vbauerster/mpb/v5/decor/doc.go b/vendor/github.com/vbauerster/mpb/v5/decor/doc.go new file mode 100644 index 000000000..6d2614451 --- /dev/null +++ b/vendor/github.com/vbauerster/mpb/v5/decor/doc.go @@ -0,0 +1,21 @@ +/* + Package decor provides common decorators for "github.com/vbauerster/mpb/v5" 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 |