Skip to content

Commit

Permalink
add to MinTopicSize godoc re topic size
Browse files Browse the repository at this point in the history
  • Loading branch information
renaynay authored and vyzo committed Dec 22, 2021
1 parent c6dd285 commit 3b1c59c
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion discovery.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,8 @@ type discover struct {
}

// MinTopicSize returns a function that checks if a router is ready for publishing based on the topic size.
// The router ultimately decides the whether it is ready or not, the given size is just a suggestion.
// The router ultimately decides the whether it is ready or not, the given size is just a suggestion. Note
// that the topic size does not include the host in the count.
func MinTopicSize(size int) RouterReady {
return func(rt PubSubRouter, topic string) (bool, error) {
return rt.EnoughPeers(topic, size), nil
Expand Down

0 comments on commit 3b1c59c

Please sign in to comment.