diff --git a/SConstruct b/SConstruct index 502317cf4f8..317d3058c0d 100644 --- a/SConstruct +++ b/SConstruct @@ -78,8 +78,7 @@ if not COMMAND_LINE_TARGETS: sys.exit(1) if parse_version(SCons.__version__) < parse_version("3.0.0"): - logger.error("Cantera requires SCons with a minimum version of 3.0.0. Exiting.", - print_level=False) + logger.error("Cantera requires SCons with a minimum version of 3.0.0. Exiting.") sys.exit(1) if os.name not in ["nt", "posix"]: @@ -268,8 +267,8 @@ config_options = [ """Path to the MATLAB install directory. This should be the directory containing the 'extern', 'bin', etc. subdirectories. Typical values are: "C:\\Program Files\\MATLAB\\R2021a" on Windows, - "/Applications/MATLAB_R2011a.app" on macOS, or - "/opt/MATLAB/R2011a" on Linux.""", + "/Applications/MATLAB_R2021a.app" on macOS, or + "/opt/MATLAB/R2021a" on Linux.""", "", PathVariable.PathAccept), EnumOption( "f90_interface", diff --git a/site_scons/buildutils.py b/site_scons/buildutils.py index 7b4fe8e7c95..b31eb76742c 100644 --- a/site_scons/buildutils.py +++ b/site_scons/buildutils.py @@ -37,7 +37,13 @@ class Option: - """Object corresponding to SCons configuration option""" + """Object corresponding to SCons configuration option. + + The purpose of this class is to collect system-dependent default parameters for + SCons configuration options, which are made available to both help text and + reST documentation. The class works in conjunction with the `Configuration` class + to select and convert system-dependent parameters to SCons configuration options. + """ def __init__(self, name: str, @@ -281,8 +287,11 @@ def to_scons(self, env: "Optional[SCEnvironment]" = None) -> "SCVariables": class Configuration: """ - Class enabling selection of options based on attribute dictionary entries that - allow for differentiation between platform/compiler dependent options. + Class enabling selection of options based on a dictionary of `Option` objects + that allows for a differentiation between platform/compiler dependent options. + + In addition, the class facilitiates the generation of formatted help text and + reST documentation. """ header = [