syncutil: imp docs

AdguardTeam · Dec 1, 2023 · bfb2120 · bfb2120
1 parent 9fba2b5
commit bfb2120
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/syncutil/sema.go b/syncutil/sema.go
@@ -25,10 +25,12 @@ func (EmptySemaphore) Acquire(_ context.Context) (err error) { return nil }
 // Release implements the [Semaphore] interface for EmptySemaphore.
 func (EmptySemaphore) Release() {}
 
-// unit is an alias for struct{} to type less.
+// unit is a convenient alias for struct{}.
 type unit = struct{}
 
 // ChanSemaphore is a channel-based semaphore.
+//
+// It must be initialized with [NewChanSemaphore].
 type ChanSemaphore struct {
 	c chan unit
 }