Elaborate on moves not necessarily representing all moves.

RACCommunity · Oct 21, 2017 · a0985d8 · a0985d8
1 parent 42ed918
commit a0985d8
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/FlexibleDiff/Changeset.swift b/FlexibleDiff/Changeset.swift
@@ -98,7 +98,11 @@ public struct Changeset {
 	///              start index and the offset.
 	public var mutations = IndexSet()
 
-	/// The offset pairs of moves with a mutation flag as the associated value.
+	/// The offset pairs of moves.
+	///
+	/// These represent only the required moves for reproducing the current version from the
+	/// previous version — moves being implied by preceding removals and insertions could
+	/// have been eliminated as an optimization.
 	///
 	/// The source offset is semantically equivalent to a removal offset, while the
 	/// destination offset is semantically equivalent to an insertion offset.