Skip to content

Commit 3a76bfc

Browse files
authored
Fix cfdm.Field.coordinates docstring formatting
1 parent 2cfcf7f commit 3a76bfc

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

cfdm/mixin/fielddomain.py

+25-15
Original file line numberDiff line numberDiff line change
@@ -812,10 +812,10 @@ def coordinates(self, *identities, **filter_kwargs):
812812
"auxiliary_coordinate"], filter_by_identity=identities,
813813
**filter_kwargs)``.
814814
815-
. versionadded:: (cfdm) 1.7.0
815+
.. versionadded:: (cfdm) 1.7.0
816816
817-
. seealso:: `auxiliary_coordinates`, `constructs`,
818-
`dimension_coordinates`
817+
.. seealso:: `auxiliary_coordinates`, `constructs`,
818+
`dimension_coordinates`
819819
820820
:Parameters:
821821
@@ -841,19 +841,29 @@ def coordinates(self, *identities, **filter_kwargs):
841841
842842
**Examples**
843843
844-
>> f.coordinates()
845-
Constructs:
846-
}
847-
848-
>> f.coordinates()
844+
>>> f = {{package}}.example_field(7)
845+
>>> print(f)
846+
Field: eastward_wind (ncvar%ua)
847+
-------------------------------
848+
Data : eastward_wind(time(3), air_pressure(1), grid_latitude(4), grid_longitude(5)) m s-1
849+
Cell methods : time(3): mean
850+
Dimension coords: time(3) = [1979-05-01 12:00:00, 1979-05-02 12:00:00, 1979-05-03 12:00:00] gregorian
851+
: air_pressure(1) = [850.0] hPa
852+
: grid_latitude(4) = [0.44, ..., -0.88] degrees
853+
: grid_longitude(5) = [-1.18, ..., 0.58] degrees
854+
Auxiliary coords: latitude(grid_latitude(4), grid_longitude(5)) = [[52.4243, ..., 51.1163]] degrees_north
855+
: longitude(grid_latitude(4), grid_longitude(5)) = [[8.0648, ..., 10.9238]] degrees_east
856+
Coord references: grid_mapping_name:rotated_latitude_longitude
857+
>>> f.coordinates()
858+
<Constructs: auxiliary_coordinate(2), dimension_coordinate(4)>
859+
>>> print(f.coordinates())
849860
Constructs:
850-
'auxiliarycoordinate0': <{{repr}}AuxiliaryCoordinate: latitude(10, 9) degrees_N>,
851-
'auxiliarycoordinate1': <{{repr}}AuxiliaryCoordinate: longitude(9, 10) degrees_E>,
852-
'auxiliarycoordinate2': <{{repr}}AuxiliaryCoordinate: long_name=Grid latitude name(10) >,
853-
'dimensioncoordinate0': <{{repr}}DimensionCoordinate: atmosphere_hybrid_height_coordinate(1) >,
854-
'dimensioncoordinate1': <{{repr}}DimensionCoordinate: grid_latitude(10) degrees>,
855-
'dimensioncoordinate2': <{{repr}}DimensionCoordinate: grid_longitude(9) degrees>,
856-
'dimensioncoordinate3': <{{repr}}DimensionCoordinate: time(1) days since 2018-12-01 >}
861+
{'auxiliarycoordinate0': <{{repr}}AuxiliaryCoordinate: latitude(4, 5) degrees_north>,
862+
'auxiliarycoordinate1': <{{repr}}AuxiliaryCoordinate: longitude(4, 5) degrees_east>,
863+
'dimensioncoordinate0': <{{repr}}DimensionCoordinate: time(3) days since 1979-1-1 gregorian>,
864+
'dimensioncoordinate1': <{{repr}}DimensionCoordinate: air_pressure(1) hPa>,
865+
'dimensioncoordinate2': <{{repr}}DimensionCoordinate: grid_latitude(4) degrees>,
866+
'dimensioncoordinate3': <{{repr}}DimensionCoordinate: grid_longitude(5) degrees>}
857867
858868
"""
859869
return self._filter_interface(

0 commit comments

Comments
 (0)