Use flyspell to find spelling issues to fix typos

Author: sadielbartholomew

visiontoolkit/cli.py

@@ -430,7 +430,7 @@ def process_config():
     Order values are set in:
       1. Defaults set first, to ensure everything has a valid value, then...
       2. Overidden by any config. file specifications, which are in turn...
-      3. Overidden by any CLI options provided, which are aways applied over
+      3. Overidden by any CLI options provided, which are always applied over
          the former.
 
     Overwrite any config. specified in the config. file given with the CLI
@@ -451,7 +451,7 @@ def process_config():
     # to fill in whatever is not provided from the command.
     parsed_args = parser.parse_args()
 
-    # Configure logging - do this now since otherwise folowing log messages
+    # Configure logging - do this now since otherwise following log messages
     # get missed!
     setup_logging(parsed_args.verbose)
 
@@ -500,7 +500,7 @@ def validate_config(final_config_namespace):
 
     TODO: DETAILED DOCS
     """
-    # TODO add validation in incrementally to cover all input options & args!
+    # TODO add validation in incrementally to cover all input options & args
 
     print("final_config_namespace is", final_config_namespace)
 
@@ -522,8 +522,11 @@ def process_config_file(config_file):
         try:
             j = json.load(f)
         except (json.decoder.JSONDecodeError, AttributeError):
-            raise ValueError("Bad JSON configuration file.")  # TODO better msg
+            raise ValueError(
+                "The configuration file specified is not valid JSON: "
+                f"{config_file}"
+            )
 
-    logger.info(f"Succesfully read-in JSON config. file at: {config_file}")
+    logger.info(f"Successfully read-in JSON config. file at: {config_file}")
 
     return j

visiontoolkit/constants.py

@@ -6,7 +6,7 @@
     # *** Script running options ***
     # Configure messaging to STDOUT, which is very verbose if INFO=True, else
     # as minimal as allows without log control in cf-plot (at present).
-    # TODO: Get ESMF logging via cf incoporated into Python logging system,
+    # TODO: Get ESMF logging via cf incorporated into Python logging system,
     # see Issue #286.
     "verbose": 0,  # corresponds to a count of 0 (-v would be 1, -vv 2, etc.)
     # *** Run mode with time override(s) ***
@@ -15,7 +15,7 @@
     #    datetimes of the observational input data (set "False"),
     # 2. where the times on the observations are ignored so that they are
     #    set and assumed to take a given start time, as specified as one
-    #    datetime string. Datetimes are assuemd to be UTC and should be
+    #    datetime string. Datetimes are assumed to be UTC and should be
     #    pre-converted from another timezones before input if applicable.
     #
     #    TODO: could have a shortcut if want to assume start time of model?
@@ -43,7 +43,7 @@
     "output-file-name": "vision_toolkit_result_field.nc",
     "history-message": (
         "Processed using the NCAS VISION Toolkit to "
-        "colocate from model data to the observational data "
+        "co-locate from model data to the observational data "
         "spatio-temporal location."
     ),
     # *** Subspacing options ***
@@ -53,7 +53,7 @@
     # Note this option except in rare cases won't be required, as should almost
     # always be able to determine what z-coordinate want given it must be
     # present in both the model and the observational data, so match those.
-    # Only if both data have more than one of identical z-coord do we need
+    # Only if both data have more than one of identical z-coordinate do we need
     # to ask for this info.
     # Pressure will always be the ideal case, so that is our default and if
     # it can't be found, we look for other ways forward for the vertical.

visiontoolkit/plotting.py

@@ -138,7 +138,7 @@ def output_plots(
         file=f"{outputs_dir}/{plotname_start}_final_colocated_field.png",
     )
 
-    # Set levels for plotting of data in a colourmap
+    # Set levels for plotting of data in a colour map
     # Min, max as determined using output.min(), .max():
     if cfp_output_levs_config:
         cfp.levs(**cfp_output_levs_config)