Skip to content

Commit bef937e

Browse files
Add coverage to examples in compute_vertical_coordinates docstring
1 parent 49b08b2 commit bef937e

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

cf/field.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9619,7 +9619,7 @@ def compute_vertical_coordinates(
96199619
>>> print(f.auxiliary_coordinate('altitude', default=None))
96209620
None
96219621
>>> g = f.compute_vertical_coordinates()
9622-
>>> print(g.auxiliary_coordinates)
9622+
>>> print(g.auxiliary_coordinates())
96239623
Constructs:
96249624
{'auxiliarycoordinate0': <CF AuxiliaryCoordinate: latitude(10, 9) degrees_N>,
96259625
'auxiliarycoordinate1': <CF AuxiliaryCoordinate: longitude(9, 10) degrees_E>,
@@ -9635,6 +9635,22 @@ def compute_vertical_coordinates(
96359635
Bounds:units = 'm'
96369636
Bounds:Data(1, 10, 9, 2) = [[[[5.0, ..., 5415.0]]]] m
96379637

9638+
>>> g, key = f.compute_vertical_coordinates(key=True)
9639+
>>> g
9640+
<CF Field: air_temperature(atmosphere_hybrid_height_coordinate(1), grid_latitude(10), grid_longitude(9)) K>
9641+
>>> key
9642+
'auxiliarycoordinate3'
9643+
9644+
>>> i = f.compute_vertical_coordinates(inplace=True)
9645+
>>> print(i)
9646+
None
9647+
>>> print(f.auxiliary_coordinates())
9648+
Constructs:
9649+
{'auxiliarycoordinate0': <CF AuxiliaryCoordinate: latitude(10, 9) degrees_N>,
9650+
'auxiliarycoordinate1': <CF AuxiliaryCoordinate: longitude(9, 10) degrees_E>,
9651+
'auxiliarycoordinate2': <CF AuxiliaryCoordinate: long_name=Grid latitude name(10) >,
9652+
'auxiliarycoordinate3': <CF AuxiliaryCoordinate: altitude(1, 10, 9) m>}
9653+
96389654
"""
96399655
f = _inplace_enabled_define_and_cleanup(self)
96409656

0 commit comments

Comments
 (0)