Update utils.py

PennLINC · Feb 3, 2025 · 82949a4 · 82949a4
1 parent ea5042e
commit 82949a4
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/cubids/utils.py b/cubids/utils.py
@@ -83,8 +83,13 @@ def _file_to_entity_set(filename):
 
     Returns
     -------
-    set
+    str
         A set of entities extracted from the filename.
+
+    Examples
+    --------
+    >>> _file_to_entity_set("sub-01_ses-01_task-rest_bold.nii.gz")
+    'task-rest_suffix-bold'
     """
     entities = parse_file_entities(str(filename))
     return _entities_to_entity_set(entities)