Add docstring to pubsub.Publisher

Signed-off-by: Alexander Morozov <lk4d4@docker.com>
SerhatG · Jul 14, 2015 · 7080f5d · 7080f5d
1 parent cf09e43
commit 7080f5d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/pkg/pubsub/publisher.go b/pkg/pubsub/publisher.go
@@ -19,6 +19,8 @@ func NewPublisher(publishTimeout time.Duration, buffer int) *Publisher {
 
 type subscriber chan interface{}
 
+// Publisher is basic pub/sub structure. Allows to send events and subscribe
+// to them. Can be safely used from multiple goroutines.
 type Publisher struct {
 	m           sync.RWMutex
 	buffer      int