From c30cf154ae41ebe14ed772fc72750b5ac3534161 Mon Sep 17 00:00:00 2001
From: Taylor Salo <salot@pennmedicine.upenn.edu>
Date: Mon, 17 Feb 2025 13:27:10 -0500
Subject: [PATCH] Update utils.py

---
 cubids/utils.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/cubids/utils.py b/cubids/utils.py
index 15e72a91..4eeefb2d 100644
--- a/cubids/utils.py
+++ b/cubids/utils.py
@@ -129,6 +129,13 @@ def _file_to_entity_set(filename):
     str
         A set of entities extracted from the filename.
 
+    Notes
+    -----
+    This function relies on the variable NON_KEY_ENTITIES from cubids.constants.
+    This is a set of entities to ignore in the entity set.
+    The constant may be modified by the CuBIDS class, which will remove "session"
+    if is_longitudinal is True and acq_group_level is "session".
+
     Examples
     --------
     >>> _file_to_entity_set("sub-01_ses-01_task-rest_bold.nii.gz")