diff --git a/src/linkahead/apiutils.py b/src/linkahead/apiutils.py index d654905489e67b497abfae293b8eaca10f2f4d18..fab8c14ff84d733c7e96013e0fcc8e643eb1dd2b 100644 --- a/src/linkahead/apiutils.py +++ b/src/linkahead/apiutils.py @@ -527,6 +527,18 @@ def merge_entities(entity_a: Entity, def describe_diff(olddiff, newdiff, name=None, as_update=True): + """ + This function generates a textual representation of the differences between two entities that have been generated + using compare_entities. + + Arguments: + ---------- + olddiff: The diff output for the entity marked as "old". + newdiff: The diff output for the entity marked as "new". + + Example: + >>> describe_diff(*compare_entities(db.Record().add_property("P"), "value", db.Record())) + """ description = "" for attr in list(set(list(olddiff.keys()) + list(newdiff.keys()))):