Skip to content

Commit fb20ff2

Browse files
committed
Update docstring formatting and mkdocs config
1 parent 9f6f75a commit fb20ff2

4 files changed

Lines changed: 10 additions & 8 deletions

File tree

docs/LICENSE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../LICENSE

esgf_qa/cluster_results.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ class QAResultAggregator:
1414
and files, normalizes them into a consistent internal summary structure, and provides
1515
functionality to sort, cluster, and generalize similar messages.
1616
17-
Parameters
18-
----------
19-
checker_dict : dict
20-
Dictionary mapping checker names (e.g., ``"cf"``) to human-readable labels.
21-
Used to label tests and messages in the summary.
22-
2317
Attributes
2418
----------
2519
summary : dict of defaultdict
@@ -33,7 +27,10 @@ class QAResultAggregator:
3327
messages are generalized and aggregated/clustered across similar text patterns.
3428
checker_dict : dict
3529
Mapping of checker identifiers to human-readable names, used
36-
for consistent labeling in summaries.
30+
for consistent labeling in summaries. Only cc checks.
31+
checker_dict_ext : dict
32+
Mapping of checker identifiers to human-readable names, used
33+
for consistent labeling in summaries. cc checks extended by esgf_qa checks.
3734
3835
Methods
3936
-------

esgf_qa/con_checks.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@ def consistency_checks(ds, ds_map, files_to_check_dict, checker_options):
155155
Consistency checks.
156156
157157
Runs inter-file consistency checks on a dataset:
158+
158159
- Global attributes (values and data types)
159160
- Variable attributes (values and data types)
160161
- Coordinates (values)
@@ -443,6 +444,7 @@ def compatibility_checks(ds, ds_map, files_to_check_dict, checker_options):
443444
Compatibility checks for a dataset.
444445
445446
Checks for:
447+
446448
- xarray open_mfdataset (compat='override', join='outer')
447449
- xarray open_mfdataset (compat='no_conflicts', join='exact')
448450
@@ -607,6 +609,7 @@ def inter_dataset_consistency_checks(ds_map, files_to_check_dict, checker_option
607609
608610
Will group datasets by realm and grid for certain checks.
609611
Runs inter-dataset consistency checks:
612+
610613
- Required and non-required global attributes (values and data types)
611614
- Coordinates (values)
612615
- Dimensions (names and sizes)

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ plugins:
2626
docstring_style: numpy
2727
show_source: true
2828
show_signature: true
29-
29+
extra:
30+
rendering_style: markdown

0 commit comments

Comments
 (0)