cleanup

Author: dcherian

cf_xarray/geometry.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import copy
 from collections.abc import Sequence
 
 import numpy as np
@@ -8,15 +9,21 @@
 
 GEOMETRY_CONTAINER_NAME = "geometry_container"
 
+__all__ = [
+    "decode_geometries",
+    "encode_geometries",
+    "cf_to_shapely",
+    "shapely_to_cf",
+]
+
 
 def decode_geometries(encoded: xr.Dataset) -> xr.Dataset:
     """
-    Decodes CF encoded geometries to a numpy object array
-    containing shapely geometries.
+    Decode CF encoded geometries to a numpy object array containing shapely geometries.
 
     Parameters
     ----------
-    encoded: Dataset
+    encoded : Dataset
         A Xarray Dataset containing encoded geometries.
 
     Returns
@@ -74,14 +81,9 @@ def decode_geometries(encoded: xr.Dataset) -> xr.Dataset:
     return decoded
 
 
-import copy
-
-GEOMETRY_CONTAINER_NAME = "geometry_container"
-
-
 def encode_geometries(ds: xr.Dataset):
     """
-    Encodes any discovered geometry variables using the CF conventions.
+    Encode any discovered geometry variables using the CF conventions.
 
     Practically speaking, geometry variables are numpy object arrays where the first
     element is a shapely geometry.
@@ -93,7 +95,7 @@ def encode_geometries(ds: xr.Dataset):
 
     Parameters
     ----------
-    ds: Dataset
+    ds : Dataset
        Dataset containing at least one geometry variable.
 
     Returns

doc/geometry.md

@@ -8,15 +8,15 @@ kernelspec:
 ---
 
 ```{eval-rst}
-.. currentmodule:: xarray
+.. currentmodule:: cf_xarray
 ```
 
 # Geometries
 
 ```{seealso}
 1. [The CF conventions on Geometries](http://cfconventions.org/Data/cf-conventions/cf-conventions-1.11/cf-conventions.html#geometries)
-1. {py:func}`cf_xarray.shapely_to_cf`
-1. {py:func}`cf_xarray.cf_to_shapely`
+1. {py:func}`shapely_to_cf`
+1. {py:func}`cf_to_shapely`
 ```
 
 `cf_xarray` can convert between vector geometries represented as shapely objects
@@ -42,6 +42,7 @@ da = xr.DataArray(
     dims=("index",),
     name="geometry"
 )
+da
 ```
 
 ```{warning}
@@ -73,7 +74,7 @@ ds.identical(decoded)
 
 ## Lower-level conversions
 
-Encoding a single DataArray is possible using {py:func}`cf_xarray.geometry.shapely_to_cf`.
+Encoding a single DataArray is possible using {py:func}`geometry.shapely_to_cf`.
 
 ```{code-cell}
 ds_cf = cfxr.shapely_to_cf(da)