From 3bd7191cbaec2d365acabf75478af53b2db73be0 Mon Sep 17 00:00:00 2001
From: "i.nueske" <i.nueske@indiscale.com>
Date: Sat, 30 Nov 2024 12:49:39 +0100
Subject: [PATCH] DOC: Update compare_entities Docstring to describe which keys
are used in the diff
---
src/linkahead/apiutils.py | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/src/linkahead/apiutils.py b/src/linkahead/apiutils.py
index 1504db8e..fd2c23d6 100644
--- a/src/linkahead/apiutils.py
+++ b/src/linkahead/apiutils.py
@@ -196,6 +196,8 @@ def compare_entities(entity0: Optional[Entity] = None,
that are missing in the other entity, and the 'properties' dict contains
properties and SPECIAL_ATTRIBUTES if they are missing or different from
their counterparts in the other entity.
+ The key used to represent a parent or property is the entities name if the
+ name is present for both compared entities, the id otherwise.
The value of the properties dict for each listed property is again a dict
detailing the differences between this property and its counterpart.
@@ -224,9 +226,9 @@ def compare_entities(entity0: Optional[Entity] = None,
Params
------
- entity0 : Entity
+ entity0: Entity
First entity to be compared.
- entity1 : Entity
+ entity1: Entity
Second entity to be compared.
compare_referenced_records: bool, default: False
If set to True, values with referenced records
--
GitLab