From d32b0d585d66c9b2ba9724b1d09f727518455adb Mon Sep 17 00:00:00 2001 From: James Edwards Date: Wed, 13 Dec 2023 06:54:32 -0700 Subject: [PATCH] add documentation of schema variable --- CIME/XML/generic_xml.py | 3 ++- CIME/XML/machines.py | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CIME/XML/generic_xml.py b/CIME/XML/generic_xml.py index d24101a8b26..3b303047ad3 100644 --- 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 index 1916a8eee76..a9536d74572 100644 --- 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