tweak code comments

otlp/common.go

@@ -39,7 +39,7 @@ const (
 	unknownLogSource         = "unknown_log_source"
 
 	// maxDepth is the maximum depth of a nested kvlist attribute that will be flattened.
-	// If the depth is exceeded, the attribute should be added as a JSON string.
+	// If the depth is exceeded, the attribute should be added as a JSON string instead.
 	maxDepth = 5
 )
 
@@ -261,7 +261,7 @@ func getValueFromMetadata(md metadata.MD, key string) string {
 // AddAttributesToMap adds attributes to a map, extracting the underlying attribute data type.
 // Supported types are string, bool, double, int, bytes, array, and kvlist.
 // kvlist attributes are flattened to a depth of (maxDepth), if the depth is exceeded, the attribute is added as a JSON string.
-// Bytes and array values are added as JSON strings.
+// Bytes and array values are always added as JSON strings.
 func AddAttributesToMap(attrs map[string]interface{}, attributes []*common.KeyValue) {
 	for _, attr := range attributes {
 		// ignore entries if the key is empty or value is nil
@@ -403,7 +403,7 @@ func getMarshallableValue(value *common.AnyValue) interface{} {
 // addAttributeToMap adds an attribute to a map, extracting the underlying attribute data type.
 // Supported types are string, bool, double, int, bytes, array, and kvlist.
 // kvlist attributes are flattened to a depth of (maxDepth), if the depth is exceeded, the attribute is added as a JSON string.
-// Bytes and array values are added as JSON strings.
+// Bytes and array values are always added as JSON strings.
 func addAttributeToMap(result map[string]interface{}, key string, value *common.AnyValue, depth int) {
 	switch value.Value.(type) {
 	case *common.AnyValue_StringValue: