add documentation of schema variable

ESMCI · Dec 15, 2023 · d32b0d5 · d32b0d5
1 parent 463b11e
commit d32b0d5
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CIME/XML/generic_xml.py b/CIME/XML/generic_xml.py
@@ -105,7 +105,8 @@ def __init__(
 
     def read(self, infile, schema=None):
         """
-        Read and parse an xml file into the object
+        Read and parse an xml file into the object.  The schema variable can either be a path to an xsd schema file or
+        a dictionary of paths to files by version.
         """
         cached_read = False
         if not self.DISABLE_CACHING and infile in self._FILEMAP:

diff --git a/CIME/XML/machines.py b/CIME/XML/machines.py
@@ -30,6 +30,9 @@ def __init__(
         additional directory that will be searched for a config_machines.xml file; if
         found, the contents of this file will be appended to the standard
         config_machines.xml. An empty string is treated the same as None.
+
+        The schema variable can be passed as a path to an xsd schema file or a dictionary of paths
+        with version number as keys.
         """
 
         self.machine_node = None