add comments to CreateMergePatch

Signed-off-by: Curtis La Graff <[email protected]>
evanphx · Mar 21, 2018 · ce89457 · ce89457
1 parent 05e46dc
commit ce89457
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/merge.go b/merge.go
@@ -185,14 +185,17 @@ func CreateMergePatch(originalJSON, modifiedJSON []byte) ([]byte, error) {
 	originalResemblesArray := resemblesJSONArray(originalJSON)
 	modifiedResemblesArray := resemblesJSONArray(modifiedJSON)
 
+	// Do both byte-slices seem like JSON arrays?
 	if originalResemblesArray && modifiedResemblesArray {
 		return createArrayMergePatch(originalJSON, modifiedJSON)
 	}
 
+	// Are both byte-slices are not arrays? Then they are likely JSON objects...
 	if !originalResemblesArray && !modifiedResemblesArray {
 		return createObjectMergePatch(originalJSON, modifiedJSON)
 	}
 
+	// None of the above? Then return an error because of mismatched types.
 	return nil, errBadMergeTypes
 }