comments

laws-africa · Feb 11, 2025 · f5c3a57 · f5c3a57
1 parent bbfd577
commit f5c3a57
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/indigo/analysis/refs/provision_refs.peg b/indigo/analysis/refs/provision_refs.peg
@@ -106,6 +106,9 @@ grammar ProvisionRefs
 
   # --------
   # translated terminals
+  #
+  # NB: if items are changed or added here, the list of the XML elements they correspond to must be updated in
+  #     ProvisionRefsReslover.element_names in indigo/analysis/refs/provisions.py
   # --------
 
                  # english

diff --git a/indigo/analysis/refs/provisions.py b/indigo/analysis/refs/provisions.py
@@ -200,6 +200,12 @@ def thereof(self, input, start, end, elements):
 class ProvisionRefsResolver:
     """Resolves references such as Section 32(a) to eIds in an Akoma Ntoso document."""
 
+    # These are the keywords that can be matched in the text, and their corresponding element names to search for.
+    # If these items change, then the grammar must be updated to match them
+    # (see 'translated terminals' in provision_refs.peg)
+    #
+    # These also act as the basis of the pattern to look for potential references in the text to which the grammar
+    # must be applied.
     element_names = {
         # all languages
         "attachment": "attachment",