Comments for new packages

DataDog · Sep 24, 2024 · da41ae3 · da41ae3
1 parent c19ee2e
commit da41ae3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/pkg/config/nodetreemodel/config.go b/pkg/config/nodetreemodel/config.go
@@ -3,6 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
+// Package nodetreemodel defines a model for the config using a tree of nodes
 package nodetreemodel
 
 import (

diff --git a/pkg/config/teeconfig/teeconfig.go b/pkg/config/teeconfig/teeconfig.go
@@ -3,6 +3,7 @@
 // This product includes software developed at Datadog (https://www.datadoghq.com/).
 // Copyright 2016-present Datadog, Inc.
 
+// Package teeconfig is a tee of two configs that writes to both but reads from only one
 package teeconfig
 
 import (
@@ -16,12 +17,13 @@ import (
 	"github.com/DataDog/datadog-agent/pkg/config/model"
 )
 
-// teeConfig
+// teeConfig is a combination of two configs, both get written to but only baseline is read
 type teeConfig struct {
 	baseline model.Config
 	compare  model.Config
 }
 
+// NewTeeConfig constructs a new teeConfig
 func NewTeeConfig(baseline, compare model.Config) model.Config {
 	return &teeConfig{baseline: baseline, compare: compare}
 }