From 3e9afb08cbeca1264c8bcee81f263c240a3a97cf Mon Sep 17 00:00:00 2001
From: Florian Spreckelsen <f.spreckelsen@indiscale.com>
Date: Fri, 23 Aug 2024 11:51:54 +0200
Subject: [PATCH] DOC: Add in-line comments

---
 src/caoscrawler/converters.py | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/caoscrawler/converters.py b/src/caoscrawler/converters.py
index 7a153244..0eee8965 100644
--- a/src/caoscrawler/converters.py
+++ b/src/caoscrawler/converters.py
@@ -875,6 +875,7 @@ class PropertiesFromDictConverter(DictElementConverter):
                     root_record.add_property(name=key, value=ref_recs)
 
             elif isinstance(value, dict):
+                # Treat scalar reference
                 ref_var_name = f"{root_rec_name}.{key}"
                 ref_rec, keys_modified = self._create_ref_rec(
                     ref_var_name,
@@ -888,6 +889,8 @@ class PropertiesFromDictConverter(DictElementConverter):
                 )
                 root_record.add_property(key, ref_rec)
             else:
+                # All that remains are scalar properties which may or
+                # may not be special attributes like name.
                 if key.lower() in SPECIAL_PROPERTIES:
                     setattr(root_record, key.lower(), value)
                 else:
-- 
GitLab