DOC: add brief descriptions for indices

ImagingDataCommons · Aug 1, 2024 · 0c36cb1 · 0c36cb1
1 parent 85f4091
commit 0c36cb1
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/idc_index/index.py b/idc_index/index.py
@@ -70,14 +70,18 @@ def __init__(self):
         )
 
         self.indices_overview = {
-            "index": {"description": None, "installed": True, "url": None},
+            "index": {
+                "description": "Main index containing one row per DICOM series.",
+                "installed": True,
+                "url": None,
+            },
             "sm_index": {
-                "description": None,
+                "description": "DICOM Slide Microscopy series-level index.",
                 "installed": False,
                 "url": f"{asset_endpoint_url}/sm_index.parquet",
             },
             "sm_instance_index": {
-                "description": None,
+                "description": "DICOM Slide Microscopy instance-level index.",
                 "installed": False,
                 "url": f"{asset_endpoint_url}/sm_instance_index.parquet",
             },