From fd90341b213dc75bee04ba7169f5178a0c43c6e0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Tue, 29 Nov 2022 09:52:25 +0100
Subject: [PATCH] DOC: add docstring
---
src/caoscrawler/identifiable_adapters.py | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/src/caoscrawler/identifiable_adapters.py b/src/caoscrawler/identifiable_adapters.py
index 35f56126..653951f4 100644
--- a/src/caoscrawler/identifiable_adapters.py
+++ b/src/caoscrawler/identifiable_adapters.py
@@ -166,6 +166,14 @@ class IdentifiableAdapter(metaclass=ABCMeta):
"""
retrieve the registred identifiable and fill the property values to create an
identifiable
+
+ Args:
+ record: the record for which the Identifiable shall be created.
+ referencing_entities: a dictionary (Type: dict[int, dict[str, list[db.Entity]]]), that
+ allows to look up entities with a certain RecordType, that reference ``record``
+
+ Returns:
+ Identifiable, the identifiable for record.
"""
registered_identifiable = self.get_registered_identifiable(record)
--
GitLab