Update docstring for UpsertTag

Co-Authored-By: vyzo <[email protected]>
libp2p · May 6, 2019 · e845163 · e845163
1 parent 9d8184f
commit e845163
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/interface.go b/interface.go
@@ -21,6 +21,10 @@ type ConnManager interface {
 	UntagPeer(p peer.ID, tag string)
 
 	// UpsertTag updates an existing tag or inserts a new one.
+	//
+	// The connection manager calls the upsert function supplying the current
+	// value of the tag (or zero if inexistent). The return value is used as 
+	// the new value of the tag.
 	UpsertTag(p peer.ID, tag string, upsert func(int) int)
 
 	// GetTagInfo returns the metadata associated with the peer,