docs: Add message about importance of the index

CMIP-REF · Dec 11, 2024 · c3ea68b · c3ea68b
1 parent 524383b
commit c3ea68b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/packages/ref/src/ref/datasets/base.py b/packages/ref/src/ref/datasets/base.py
@@ -120,6 +120,9 @@ def load_catalog(
         """
         Load the data catalog from the database
 
+        The index of the data catalog is the primary key of the dataset.
+        This should be maintained during any processing.
+
         Returns
         -------
         :

diff --git a/packages/ref/src/ref/datasets/cmip6.py b/packages/ref/src/ref/datasets/cmip6.py
@@ -254,6 +254,9 @@ def load_catalog(
         Iterating over different datasets within the data catalog can be done using a `groupby`
         operation for the `instance_id` column.
 
+        The index of the data catalog is the primary key of the dataset.
+        This should be maintained during any processing.
+
         Returns
         -------
         :
-Original file line number
+Diff line change
@@ Expand Up / @@ -120,6 +120,9 @@ def load_catalog( @@
             """
             Load the data catalog from the database
+            The index of the data catalog is the primary key of the dataset.
+            This should be maintained during any processing.
             Returns
             -------
             :
@@ Expand Down @@