From be3b4bc22c5c078c400279139432badd53e9f0a3 Mon Sep 17 00:00:00 2001 From: Kegan Dougal Date: Fri, 4 Nov 2016 13:45:46 +0000 Subject: [PATCH] Mention 'syncing client' --- src/github.com/matrix-org/go-neb/api/api.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/github.com/matrix-org/go-neb/api/api.go b/src/github.com/matrix-org/go-neb/api/api.go index cbb8687..183dfd1 100644 --- a/src/github.com/matrix-org/go-neb/api/api.go +++ b/src/github.com/matrix-org/go-neb/api/api.go @@ -61,8 +61,8 @@ type ClientConfig struct { HomeserverURL string // The matrix access token to authenticate the requests with. AccessToken string - // True to start a sync stream for this user. If false, no /sync goroutine will be - // created and this client won't listen for new events from Matrix. For services + // True to start a sync stream for this user, making this a "syncing client". If false, no + // /sync goroutine will be created and this client won't listen for new events from Matrix. For services // which only SEND events into Matrix, it may be desirable to set Sync to false to reduce the // number of goroutines Go-NEB has to maintain. For services which respond to !commands, // Sync MUST be set to true in order to receive those commands.