DOC: Add note that the categories will be made unique and sorted. (#34)

corteva · Aug 19, 2020 · 26636b4 · 26636b4
1 parent 69a3949
commit 26636b4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/docs/examples/categorical.ipynb b/docs/examples/categorical.ipynb
@@ -81,7 +81,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "If your data is only a subset of all of the data, the list of categories you get will likely not be complete."
+    "If your data is only a subset of all of the data, the list of categories you get will likely not be complete.\n",
+    "\n",
+    "NOTE: The categories will be made unique and sorted internally if they are not already."
    ]
   },
   {

diff --git a/geocube/api/core.py b/geocube/api/core.py
@@ -69,7 +69,7 @@ def make_geocube(
         :meth:`scipy.interpolate.griddata`.
     categorical_enums: dict, optional
         A dictionary of all categories for the table columns containing categorical
-        data.
+        data. The categories will be made unique and sorted if they are not already.
         E.g. {'column_name': ['a', 'b'], 'other_column': ['c', 'd']}
     rasterize_function: function, optional
         Function to rasterize geometries. Other options are available in

diff --git a/geocube/vector_to_cube.py b/geocube/vector_to_cube.py
@@ -60,7 +60,8 @@ def __init__(self, vector_data, geobox_maker, fill=None, categorical_enums=None)
             The value to fill in the grid with for nodata. Default is NaN.
         categorical_enums: dict, optional
             A dictionary of all categories for the table columns containing
-            categorical data.
+            categorical data. The categories will be made unique and sorted
+            if they are not already.
             E.g. {'column_name': ['a', 'b'], 'other_column': ['c', 'd']}
 
         """