formatting

Author: forman

docs/rule-ref.md

@@ -5,45 +5,39 @@ New rules will be added by upcoming XRLint releases.
 
 ## Core Rules
 
+### :material-lightbulb: `content-desc`
+
+A dataset should provide information about where the data came from and what has been done to it. This information is mainly for the benefit of human readers. The rule accepts the following configuration parameters:
+
+- `globals`: list of names of required global attributes. Defaults to `['title', 'history']`.
+- `commons`: list of names of required variable attributes that can also be defined globally. Defaults to `['institution', 'source', 'references', 'comment']`.
+- `no_vars`: do not check variables at all. Defaults to `False`.
+- `ignored_vars`: list of ignored variables (regex patterns). Defaults to `['crs', 'spatial_ref']`.
+
+[:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#description-of-file-contents)
+
+Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
+
 ### :material-lightbulb: `conventions`
 
 Datasets should identify the applicable conventions using the `Conventions` attribute.
- The rule has an optional configuration parameter `match` which is a regex pattern that the value of the `Conventions` attribute must match, if any.
+ The rule has an optional configuration parameter `match` which is a regex pattern that the value of the `Conventions` attribute must match, if any. If not provided, the rule just verifies that the attribute exists and whether it is a character string.
 [:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#identification-of-conventions)
 
-Contained in:  `all`-:material-lightning-bolt:
+Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
 
 ### :material-bug: `coords-for-dims`
 
 Dimensions of data variables should have corresponding coordinates.
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
-### :material-lightbulb: `dataset-description`
-
-A dataset should provide information about where the data came from and what has been done to it. This information is mainly for the benefit of human readers. The rule accepts the following configuration parameters:
-
-- `global_attrs`: list of global attribute names. Defaults to `['title', 'history']`.
-- `var_attrs`: list of variable attribute names. Defaults to `['institution', 'source', 'references', 'comment']`.
-- `ignored_vars`: list of ignored variables (regex patterns). Defaults to `['crs', 'spatial_ref']`.
-
-[:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#description-of-file-contents)
-
-Contained in:  `all`-:material-lightning-bolt:
-
 ### :material-lightbulb: `dataset-title-attr`
 
 Datasets should be given a non-empty title.
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
 
-### :material-lightbulb: `flags`
-
-Validate attributes 'flag_values', 'flag_masks' and 'flag_meanings' that make variables that contain flag values self describing. 
-[:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#flags)
-
-Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
-
 ### :material-bug: `grid-mappings`
 
 Grid mappings, if any, shall have valid grid mapping coordinate variables.
@@ -84,9 +78,23 @@ Time coordinates should have valid and unambiguous time units encoding.
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
 
-### :material-lightbulb: `var-units-attr`
+### :material-lightbulb: `var-desc`
+
+Check that each data variable provides an identification and description of the content. The rule can be configured by parameter `attrs` which is a list of names of attributes that provides descriptive information. It defaults to `['standard_name', 'long_name']`.
+[:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#standard-name)
+
+Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:
+
+### :material-lightbulb: `var-flags`
+
+Validate attributes 'flag_values', 'flag_masks' and 'flag_meanings' that make variables that contain flag values self describing. 
+[:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#flags)
+
+Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-lightning-bolt:
+
+### :material-lightbulb: `var-units`
 
-Every variable should have a valid 'units' attribute.
+Every variable should provide a description of its units.
 [:material-information-variant:](https://cfconventions.org/cf-conventions/cf-conventions.html#units)
 
 Contained in:  `all`-:material-lightning-bolt: `recommended`-:material-alert:

xrlint/cli/engine.py

@@ -163,7 +163,7 @@ def get_files(self, file_paths: Iterable[str]) -> Iterator[tuple[str, Config]]:
 
         Returns:
             An iterator of pairs comprising a file or directory path
-              and its computed configuration.
+                and its computed configuration.
         """
         config_list, global_filter = self.config_list.split_global_filter(
             default=DEFAULT_GLOBAL_FILTER

xrlint/plugins/core/rules/content_desc.py

@@ -2,7 +2,7 @@
 
 from xrlint.node import DataArrayNode, DatasetNode
 from xrlint.plugins.core.plugin import plugin
-from xrlint.rule import RuleContext, RuleOp, RuleExit
+from xrlint.rule import RuleContext, RuleExit, RuleOp
 from xrlint.util.schema import schema
 
 DEFAULT_GLOBAL_ATTRS = ["title", "history"]

xrlint/plugins/core/rules/conventions.py

@@ -1,9 +1,8 @@
 import re
 
-
 from xrlint.node import DatasetNode
 from xrlint.plugins.core.plugin import plugin
-from xrlint.rule import RuleContext, RuleOp, RuleExit
+from xrlint.rule import RuleContext, RuleExit, RuleOp
 from xrlint.util.schema import schema