stats: imp docs

AdguardTeam · Aug 1, 2023 · 1111894 · 1111894
1 parent 904cf81
commit 1111894
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/internal/stats/stats.go b/internal/stats/stats.go
@@ -225,7 +225,7 @@ func (s *StatsCtx) Start() {
 	go s.periodicFlush()
 }
 
-// Close implements the io.Closer interface for *StatsCtx.
+// Close implements the [io.Closer] interface for *StatsCtx.
 func (s *StatsCtx) Close() (err error) {
 	defer func() { err = errors.Annotate(err, "stats: closing: %w") }()
 
@@ -256,7 +256,8 @@ func (s *StatsCtx) Close() (err error) {
 	return udb.flushUnitToDB(tx, s.curr.id)
 }
 
-// Update implements the Interface interface for *StatsCtx.  e must not be nil.
+// Update implements the [Interface] interface for *StatsCtx.  e must not be
+// nil.
 func (s *StatsCtx) Update(e *Entry) {
 	s.confMu.Lock()
 	defer s.confMu.Unlock()
@@ -289,7 +290,7 @@ func (s *StatsCtx) Update(e *Entry) {
 	s.curr.add(e)
 }
 
-// WriteDiskConfig implements the Interface interface for *StatsCtx.
+// WriteDiskConfig implements the [Interface] interface for *StatsCtx.
 func (s *StatsCtx) WriteDiskConfig(dc *Config) {
 	s.confMu.RLock()
 	defer s.confMu.RUnlock()

diff --git a/internal/stats/unit.go b/internal/stats/unit.go
@@ -15,9 +15,6 @@ import (
 	"golang.org/x/exp/slices"
 )
 
-// TODO(a.garipov): Rewrite all of this.  Add proper error handling and
-// inspection.  Improve logging.  Decrease complexity.
-
 const (
 	// maxDomains is the max number of top domains to return.
 	maxDomains = 100