From 975ca51200545a7a7df0e048c55c78d0abf0d7f4 Mon Sep 17 00:00:00 2001
From: Tyler Yahn <codingalias@gmail.com>
Date: Thu, 21 Sep 2023 07:42:43 -0700
Subject: [PATCH] Comment the Changeset fields

---
 schema/schema.go | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

diff --git a/schema/schema.go b/schema/schema.go
index ef5f671052c..ac2517ea356 100644
--- a/schema/schema.go
+++ b/schema/schema.go
@@ -78,12 +78,19 @@ func (s *Schema) validate() error {
 // Changeset is all the applicable telemetry changes for a particular semantic
 // convention version.
 type Changeset struct {
-	All        All
-	Resources  Resources
-	Spans      Spans
+	// All are the changes that apply to all telemetry before each specific
+	// telemetry changes are applied.
+	All All
+	// Resources are the changes applied to resources.
+	Resources Resources
+	// Spans are the changes applied to spans in tracing telemetry.
+	Spans Spans
+	// SpanEvents are the changes applied to span events in tracing telemetry.
 	SpanEvents SpanEvents `yaml:"span_events"`
-	Logs       Logs
-	Metrics    Metrics
+	// Logs are the changes applied to log telemetry.
+	Logs Logs
+	// Metrics are the changes applied to metric telemetry.
+	Metrics Metrics
 }
 
 // All defines the transforms that apply to all types of telemetry data.