From 9494c964f115b7b84fc76f10b0729e9313214c5f Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Thu, 22 Feb 2024 11:14:00 +0100
Subject: [PATCH] DOC: Better docstring.

---
 src/caoscrawler/identifiable_adapters.py | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/src/caoscrawler/identifiable_adapters.py b/src/caoscrawler/identifiable_adapters.py
index da31fa39..9be539fe 100644
--- a/src/caoscrawler/identifiable_adapters.py
+++ b/src/caoscrawler/identifiable_adapters.py
@@ -84,14 +84,15 @@ class IdentifiableAdapter(metaclass=ABCMeta):
 
 Some terms:
 
-- *Registered identifiable* is defined as an identifiable with:
-    - A record type as the parent
-    - A list of properties
-    - A list of referenced by statements
-- *Identifiable* is the concrete identifiable, e.g. the Record based on
-    the registered identifiable with all the values filled in.
-- *Identified record* is the result of retrieving a record based on the
-    identifiable from the database.
+- A *registered identifiable* defines an identifiable template, for example by specifying:
+    - Parent record types
+    - Properties
+    - ``is_referenced_by`` statements
+- An *identifiable* belongs to a concrete record.  It consists of identifying attributes which "fill
+  in" the *registered identifiable*.  In code, it can be represented as a Record based on the
+ *registered identifiable* with all the values filled in.
+- An *identified record* is the result of retrieving a record from the database, based on the
+  *identifiable* (and its values).
 
 General question to clarify:
 
-- 
GitLab