Skip to content

Commit

Permalink
Add coverage to examples in compute_vertical_coordinates docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
sadielbartholomew committed Feb 6, 2025
1 parent 49b08b2 commit bef937e
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion cf/field.py
Original file line number Diff line number Diff line change
Expand Up @@ -9619,7 +9619,7 @@ def compute_vertical_coordinates(
>>> print(f.auxiliary_coordinate('altitude', default=None))
None
>>> g = f.compute_vertical_coordinates()
>>> print(g.auxiliary_coordinates)
>>> print(g.auxiliary_coordinates())
Constructs:
{'auxiliarycoordinate0': <CF AuxiliaryCoordinate: latitude(10, 9) degrees_N>,
'auxiliarycoordinate1': <CF AuxiliaryCoordinate: longitude(9, 10) degrees_E>,
Expand All @@ -9635,6 +9635,22 @@ def compute_vertical_coordinates(
Bounds:units = 'm'
Bounds:Data(1, 10, 9, 2) = [[[[5.0, ..., 5415.0]]]] m

>>> g, key = f.compute_vertical_coordinates(key=True)
>>> g
<CF Field: air_temperature(atmosphere_hybrid_height_coordinate(1), grid_latitude(10), grid_longitude(9)) K>
>>> key
'auxiliarycoordinate3'

>>> i = f.compute_vertical_coordinates(inplace=True)
>>> print(i)
None
>>> print(f.auxiliary_coordinates())
Constructs:
{'auxiliarycoordinate0': <CF AuxiliaryCoordinate: latitude(10, 9) degrees_N>,
'auxiliarycoordinate1': <CF AuxiliaryCoordinate: longitude(9, 10) degrees_E>,
'auxiliarycoordinate2': <CF AuxiliaryCoordinate: long_name=Grid latitude name(10) >,
'auxiliarycoordinate3': <CF AuxiliaryCoordinate: altitude(1, 10, 9) m>}

"""
f = _inplace_enabled_define_and_cleanup(self)

Expand Down

0 comments on commit bef937e

Please sign in to comment.