X-Git-Url: https://git.giacomolli.uk/onechat/blobdiff_plain/48d7bce28b18ecef4c52c98821675605464cecb9..3cdbd017da9ae7a7045f4272f16d4b262fd01c79:/whatsapp.go

diff --git a/whatsapp.go b/whatsapp.go
index 9365173..97b1e85 100644
--- a/whatsapp.go
+++ b/whatsapp.go
@@ -54,17 +54,17 @@ const (
 	// whatsappTimeLayout is the layout of the times in the answers.
 	whatsappTimeLayout = "2006-01-02 15:04"
 
-	// whatsappPairTime is the longest time of a pairing. The library closes
-	// the pairing connection after about 160 seconds.
-	whatsappPairTime = 3 * time.Minute
+	// whatsappPairTimeout is the longest time of a pairing. The library
+	// closes the pairing connection after about 160 seconds.
+	whatsappPairTimeout = 3 * time.Minute
 
-	// whatsappLogoutTime is the longest time of the logout call of an
+	// whatsappLogoutTimeout is the longest time of the logout call of an
 	// unlink.
-	whatsappLogoutTime = 30 * time.Second
+	whatsappLogoutTimeout = 30 * time.Second
 
-	// whatsappNoticeDelay is how long a disconnection lasts before the user
-	// gets a notice.
-	whatsappNoticeDelay = 10 * time.Minute
+	// whatsappOutageNoticeDelay is the delay from a disconnection to its
+	// notice to the user.
+	whatsappOutageNoticeDelay = 10 * time.Minute
 
 	// whatsappRetryDelay is the first wait after a failed starting
 	// connection.
@@ -309,7 +309,7 @@ func (w *WhatsApp) Run(ctx context.Context, l *TurnLoop, notify func(Event)) err
 			case w.isLinked():
 				request.answer("WhatsApp is linked already. Run /whatsapp unlink first.")
 			default:
-				pairCtx, cancelPair := context.WithTimeout(ctx, whatsappPairTime)
+				pairCtx, cancelPair := context.WithTimeout(ctx, whatsappPairTimeout)
 				cancel = cancelPair
 				pairing.Go(func() {
 					defer cancelPair()
@@ -569,7 +569,7 @@ func (w *WhatsApp) startOutage() bool {
 		w.disconnectedAt = w.clock()
 		w.disconnections++
 		disconnections := w.disconnections
-		w.timer = time.AfterFunc(whatsappNoticeDelay, func() {
+		w.timer = time.AfterFunc(whatsappOutageNoticeDelay, func() {
 			w.disconnectedLong(disconnections)
 		})
 	}
@@ -654,7 +654,7 @@ func (w *WhatsApp) unlink(ctx context.Context, l *TurnLoop, answer func(text str
 	var logoutErr error
 
 	if client != nil {
-		ctx, cancel := context.WithTimeout(ctx, whatsappLogoutTime)
+		ctx, cancel := context.WithTimeout(ctx, whatsappLogoutTimeout)
 		defer cancel()
 
 		logoutErr = client.Logout(ctx)
@@ -890,8 +890,8 @@ func (w *WhatsApp) linkedBy(client WhatsAppClient) {
 // handle takes one event of the library and tells if it was handled. A message
 // goes to the inbox. The names of the groups follow the events of the groups. A
 // connection starts a catch-up of the inbox, which ends at OfflineSyncCompleted
-// or after whatsappCatchupLimit. A disconnection keeps the time of its start
-// while Run or the library tries again. After whatsappNoticeDelay of a
+// or after whatsappCatchupTimeout. A disconnection keeps the time of its start
+// while Run or the library tries again. After whatsappOutageNoticeDelay of a
 // disconnection, all clients get one notice, and they get one more when the
 // connection comes back. A disconnection that the library does not try again
 // gives a notice at once.