REVIEW: documented change in signature of function save_debug_tree

CHANGELOG.md

@@ -28,6 +28,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ConverterValidationError when the YAML header cannot be read instead of silently not matching.
 - Refactoring of the crawl.py module: Now there is a separate scanner module handling the
   collecting of information that is independent of CaosDB itself.
+- The signature of the function ``save_debug_data`` was changed to explicitely take the debug_tree
+  as its first argument. This change was necessary, as the debug_tree is no longer saved as
+  member field of the Crawler class.
 
 ### Deprecated ###
 

src/caoscrawler/crawl.py

@@ -918,6 +918,11 @@ ____________________\n""".format(i + 1, len(pending_changes)) + str(el[3]))
         return res
 
     def save_debug_data(self, debug_tree: DebugTree, filename: str):
+        """
+        Save the information contained in a debug_tree to a file named filename.
+        """
+
+        
         paths: dict[str, Union[dict, list]] = dict()
 
         def flatten_debug_info(key):