minor re-org on documentation (#144)

automerge · Apr 7, 2024 · bb38954 · bb38954
1 parent 2465070
commit bb38954
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/Sources/AutomergeUtilities/AutomergeUtilities.docc/AutomergeUtilities.md b/Sources/AutomergeUtilities/AutomergeUtilities.docc/AutomergeUtilities.md
@@ -8,13 +8,20 @@ Automerge Utilities extends Automerge's `Document` type to make it easier to par
 
 ## Topics
 
-### Walking and Parsing Automerge documents
+### Inspecting Automerge documents
 
 - ``Automerge/Document/isEmpty()``
-- ``Automerge/Document/parseToSchema(_:from:)``
 - ``Automerge/Document/schema()``
 - ``AutomergeUtilities/AutomergeValue``
 
+### Parsing the contents of an Automerge document
+
+- ``Automerge/Document/parseToSchema(_:from:)``
+
+### Comparing the contents of Automerge documents
+
+- ``Automerge/Document/equivalentContents(_:)``
+
 ### Debugging Methods
 
 - ``Automerge/Document/walk()``
diff --git a/Sources/AutomergeUtilities/Document+equivalentContents.swift b/Sources/AutomergeUtilities/Document+equivalentContents.swift
@@ -0,0 +1,14 @@
+import Automerge
+
+public extension Document {
+    /// Returns a Boolean value that indicates whether the latest contents another document are equivalent.
+    func equivalentContents(_ anotherDoc: Document) -> Bool {
+        do {
+            let doc1Contents = try self.parseToSchema(self, from: .ROOT)
+            let doc2Contents = try anotherDoc.parseToSchema(anotherDoc, from: .ROOT)
+            return doc1Contents == doc2Contents
+        } catch {
+            return false
+        }
+    }
+}