comment(build-namelist): Add a comment to address a code review point

ESCOMP · Dec 2, 2024 · 1556914 · 1556914
1 parent 1a352be
commit 1556914
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/bld/CLMBuildNamelist.pm b/bld/CLMBuildNamelist.pm
@@ -678,11 +678,18 @@ sub setup_cmdl_chk_res {
   }
 }
 
+#-------------------------------------------------------------------------------
+
 sub begins_with
 {
+    # Arguments: long-string, substring
+    # For an input long-string check if it starts with the substring
+    # For example, if a string like NEON_PRISM starts with NEON
     return substr($_[0], 0, length($_[1])) eq $_[1];
 }
 
+#-------------------------------------------------------------------------------
+
 sub setup_cmdl_resolution {
   my ($opts, $nl_flags, $definition, $defaults, $envxml_ref) = @_;