comments: clear up correlateOldValueForChildAtNewIndex godoc

This commit is contained in:
Alexander Zielenski 2023-10-13 14:11:02 -07:00
parent 0ed67c9e41
commit d991ed56c2

View File

@ -71,15 +71,16 @@ func NewCorrelatedObject(new, old interface{}, schema Schema) *CorrelatedObject
} }
} }
// If oldValue is not a list, returns nil // If OldValue or Value is not a list, or the index is out of bounds of the
// If oldValue is a list, this function takes mapType into account and attempts // Value list, returns nil
// to find the old value with the same index or key // If oldValue is a list, this considers the x-list-type to decide how to
// correlate old values:
// //
// If listType is map, creates a map representation of the list using the designated // If listType is map, creates a map representation of the list using the designated
// map-keys, caches it for future calls, and returns the map value, or nil if // map-keys, caches it for future calls, and returns the map value, or nil if
// the correlated key is not in the old map // the correlated key is not in the old map
// //
// If the list type is not correlatable this funcion returns nil. // Otherwise, if the list type is not correlatable this funcion returns nil.
func (r *CorrelatedObject) correlateOldValueForChildAtNewIndex(index int) interface{} { func (r *CorrelatedObject) correlateOldValueForChildAtNewIndex(index int) interface{} {
oldAsList, ok := r.OldValue.([]interface{}) oldAsList, ok := r.OldValue.([]interface{})
if !ok { if !ok {