DOC: added review notes

src/caoscrawler/identifiable_adapters.py

@@ -280,6 +280,11 @@ class IdentifiableAdapter(metaclass=ABCMeta):
 
     @staticmethod
     def get_identifying_referenced_entities(record, registered_identifiable):
+        """Create a list of all entities that are referenced by record
+           and that are used as identying properties of the identifiable.
+
+           Last review by Alexander Schlemmer on 2024-05-29.
+        """
         refs = []
         for prop in registered_identifiable.properties:
             pname = prop.name.lower()

src/caoscrawler/sync_graph.py

@@ -353,6 +353,8 @@ class SyncGraph:
         Raises a RuntimeError if there is no equivalent node found and
           the (unique) string representation of the identifiable of node is already contained in
           the identifiable_look_up.
+
+        Last review by Alexander Schlemmer on 2024-05-29.
         """
         if identifiable is None:
             self.identifiableAdapter.all_identifying_properties_exist(node)
@@ -447,6 +449,8 @@ class SyncGraph:
         ("_references_id_props") and one includes references that are relevant for identifying
         backreferences/"is_referenced_by" ("_references_backref"). I.e. the two latter are subesets
         of the former reference map.
+
+        Last review by Alexander Schlemmer on 2024-05-29.
         """
         # TODO we need to treat children of RecordTypes somehow.
         forward_references: dict[int, set[SyncNode]] = {}