From 3f30d6c955d7206c5671ee481a90aee19975b82a Mon Sep 17 00:00:00 2001
From: Alexander Schlemmer <a.schlemmer@indiscale.com>
Date: Wed, 29 May 2024 20:45:31 +0200
Subject: [PATCH] DOC: added some code comments
---
src/caoscrawler/converters.py | 1 +
src/caoscrawler/scanner.py | 2 ++
2 files changed, 3 insertions(+)
diff --git a/src/caoscrawler/converters.py b/src/caoscrawler/converters.py
index d28d1d53..baf8a366 100644
--- a/src/caoscrawler/converters.py
+++ b/src/caoscrawler/converters.py
@@ -468,6 +468,7 @@ class Converter(object, metaclass=ABCMeta):
def create_records(self, values: GeneralStore, records: RecordStore,
element: StructureElement):
# TODO why is element passed but not used???
+ # ANSWER: because it might be used by overriding child classes.
if "records" not in self.definition:
return []
diff --git a/src/caoscrawler/scanner.py b/src/caoscrawler/scanner.py
index f6fc4d8f..fe8a6dbf 100644
--- a/src/caoscrawler/scanner.py
+++ b/src/caoscrawler/scanner.py
@@ -362,6 +362,8 @@ def scanner(items: list[StructureElement],
debug_tree.debug_metadata["usage"][str(element)].add(
"/".join(converters_path + [converter.name]))
mod_info = debug_tree.debug_metadata["provenance"]
+ # TODO: actually keys_modified must not be None. create_records should
+ # always return a list.
if keys_modified is not None:
for record_name, prop_name in keys_modified:
# TODO: check
--
GitLab