Skip to content

Commit 2c95111

Browse files
committed
Clarify testing sections for different attribute 'styles'.
1 parent 9984c67 commit 2c95111

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

lib/iris/tests/integration/test_netcdf.py

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1143,6 +1143,12 @@ def check_expected_results(
11431143
assert self.attrname in v.ncattrs()
11441144
assert v.getncattr(self.attrname) == value
11451145

1146+
#######################################################
1147+
# Tests on "user-style" attributes.
1148+
# This means any arbitrary attribute which a user might have added -- i.e. one with
1149+
# a name which is *not* recognised in the netCDF or CF conventions.
1150+
#
1151+
11461152
def test_usertype_single_global(self):
11471153
self.create_testcase(
11481154
attr_name="myname", # A generic "user" attribute with no special handling
@@ -1233,17 +1239,15 @@ def test_usertype_nonmatching_remainlocal(self):
12331239
var_attr_vals={"v1": "value-1", "v2": "value-2"},
12341240
)
12351241

1236-
# #####################################
1237-
# # WIP ...
1238-
# # We have a number of different "classes" of recognised attributes which are
1239-
# # handled differently.
1240-
# # We may not test all cases, but only one of each "class". Or we might be able
1241-
# # to do them all (not yet clear how).
1242+
#######################################################
1243+
# Tests on "Conventions" attribute.
1244+
# Note: the usual 'Conventions' behaviour is already tested elsewhere
1245+
# - see :class:`TestConventionsAttributes` above
1246+
#
1247+
# TODO: the name 'conventions' (lower-case) is also listed in _CF_GLOBAL_ATTRS, but
1248+
# we have excluded it from the global-attrs testing here. We probably still need to
1249+
# test what that does, though it's inclusion might simply be a mistake.
12421250
#
1243-
# #####################################
1244-
# # === "Conventions" === - which is a case to itself
1245-
# # Note: the usual 'Conventions' behaviour is already tested elsewhere
1246-
# # - see TestConventionsAttributes above
12471251

12481252
def test_conventions_var_local(self):
12491253
# What happens if 'Conventions' appears as a variable-local attribute.

0 commit comments

Comments
 (0)