Skip to content

Commit b3c45f4

Browse files
jsignelldcherian
andauthored
Apply suggestions from code review
Co-authored-by: Deepak Cherian <dcherian@users.noreply.github.com>
1 parent f2cace1 commit b3c45f4

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/geometry.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ kernelspec:
1313

1414
# Geometries
1515

16-
See
17-
16+
```seealso
17+
1. [The CF conventions on Geometries](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#geometries)
1818
1. {py:func}`cf_xarray.shapely_to_cf`
1919
1. {py:func}`cf_xarray.cf_to_shapely`
20+
```
2021

2122
In order to support vectors as well as arrays `cf_xarray` can convert between shapely objects
2223
and CF-compliant representations of those geometries.
@@ -59,15 +60,15 @@ ds_cf
5960
This function returns a `xr.Dataset` containing the CF fields needed to reconstruct the
6061
geometries. In particular there are:
6162

62-
- 'x', 'y' : the node coordinates
63-
- 'crd_x', 'crd_y' : the feature coordinates (might have different names if `grid_mapping` is available).
64-
- 'node_count' : The number of nodes per feature. Always present for Lines and Polygons. For
63+
- `'x'`, `'y'` : the node coordinates
64+
- `'crd_x'`, `'crd_y'` : the feature coordinates (might have different names if `grid_mapping` is available).
65+
- `'node_count'` : The number of nodes per feature. Always present for Lines and Polygons. For
6566
Points: only present if there are multipart geometries.
66-
- part_node_count : The number of nodes per individual geometry. Only for Lines with multipart
67+
- `'part_node_count'` : The number of nodes per individual geometry. Only for Lines with multipart
6768
geometries and for Polygons with multipart geometries or holes.
68-
- interior_ring : Integer boolean indicating whether ring is interior or exterior. Only for
69+
- `'interior_ring'` : Integer boolean indicating whether ring is interior or exterior. Only for
6970
Polygons with holes.
70-
- 'geometry_container' : Empty variable with attributes describing the geometry type.
71+
- `'geometry_container`' : Empty variable with attributes describing the geometry type.
7172

7273
Here are the attributes on `geometry_container`. This pattern mimics the convention of
7374
specifying spatial reference information in the attrs of the empty array `spatial_ref`.

0 commit comments

Comments
 (0)