Add documentation

nineteendo · Aug 20, 2024 · 1f41ad4 · 1f41ad4
1 parent 9ecb6e7
commit 1f41ad4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -78,6 +78,12 @@ Decoding JSON::
     ...
     ['filesystem API']
 
+Making a patch::
+
+    >>> import jsonyx as json
+    >>> json.make_patch([1, 2, 3, 5], [1, 3, 4, 5])
+    [{'op': 'del', 'path': '$[1]'}, {'op': 'insert', 'path': '$[2]', 'value': 4}]
+
 Applying a patch::
 
     >>> import jsonyx as json

diff --git a/src/jsonyx/_differ.py b/src/jsonyx/_differ.py
@@ -145,3 +145,6 @@ def make_patch(old: Any, new: Any) -> list[dict[str, Any]]:
     patch: list[dict[str, Any]] = []
     _make_patch(old, new, patch)
     return patch
+
+
+make_patch.__module__ = "jsonyx"