From 7cb33452ab9d98703512e6455287ae5c46b8f48b Mon Sep 17 00:00:00 2001
From: Alexander Schlemmer <a.schlemmer@indiscale.com>
Date: Wed, 29 May 2024 10:18:31 +0200
Subject: [PATCH] DOC: added an explanation of a global variable

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

diff --git a/src/caoscrawler/converters.py b/src/caoscrawler/converters.py
index b307e137..cce5146e 100644
--- a/src/caoscrawler/converters.py
+++ b/src/caoscrawler/converters.py
@@ -53,11 +53,15 @@ from .utils import has_parent
 # by the converters:
 SPECIAL_PROPERTIES = ("description", "name", "id", "path",
                       "file", "checksum", "size")
+# This RE is used to check whether a value is just a single variable:
 SINGLE_VAR_RE = re.compile(r"^\$(\{)?(?P<varname>\w+)(\})?$")
 logger = logging.getLogger(__name__)
 
 
 class CrawlerTemplate(Template):
+    # This adds a dot to the default pattern.
+    # See: https://docs.python.org/3/library/string.html#template-strings
+    # Default flags is re.IGNORECASE
     braceidpattern = r"(?a:[_a-z][_\.a-z0-9]*)"
 
 
-- 
GitLab