Improved docs

Author: forman

docs/rule-ref.md

@@ -116,7 +116,7 @@ Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning
 
 ### :material-lightbulb: `ml-dataset-meta`
 
-Multi-level datasets should provide '.zlevels' meta information file and if so, it should be consistent.
+Multi-level datasets should provide a '.zlevels' meta-info file, and if so, it should be consistent. Without the meta-info file the multi-level dataset cannot be reliably extended by new time slices as the aggregation method used for each variable must be specified.
 [:material-information-variant:](https://xcube.readthedocs.io/en/latest/mldatasets.html#the-xcube-levels-format)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:

xrlint/plugins/core/rules/time_coordinate.py

@@ -140,7 +140,7 @@ def data_array(self, ctx: RuleContext, node: DataArrayNode):
 
             if not tz_part:
                 ctx.report(
-                    f"Missing timezone '+H:MM' or '-H:MM' in 'units' attribute: {units!r}.",
+                    f"Missing timezone in 'units' attribute: {units!r}.",
                     suggestions=[
                         _units_format_suggestion(),
                         f"Append timezone specification, e.g., use"

xrlint/plugins/xcube/rules/ml_dataset_meta.py

@@ -11,8 +11,11 @@
     version="1.0.0",
     type="suggestion",
     description=(
-        f"Multi-level datasets should provide {ML_META_FILENAME!r}"
-        f" meta information file and if so, it should be consistent."
+        f"Multi-level datasets should provide a {ML_META_FILENAME!r}"
+        f" meta-info file, and if so, it should be consistent."
+        f" Without the meta-info file the multi-level dataset cannot be"
+        f" reliably extended by new time slices as the aggregation method"
+        f" used for each variable must be specified."
     ),
     docs_url=(
         "https://xcube.readthedocs.io/en/latest/mldatasets.html#the-xcube-levels-format"
@@ -34,8 +37,13 @@ def dataset(self, ctx: RuleContext, node: DatasetNode):
         meta = level_info.meta
         if meta is None:
             ctx.report(
-                f"Missing {ML_META_FILENAME!r} meta-info file,"
-                f" therefore dataset cannot be extended."
+                f"Missing {ML_META_FILENAME!r} meta-info file.",
+                suggestions=[
+                    f"Add {ML_META_FILENAME!r} meta-info file."
+                    f" Without the meta-info the dataset cannot be reliably extended"
+                    f" as the aggregation method used for each variable must be"
+                    f" specified."
+                ],
             )
             return