From c71368e38116d8475642d697694e36906afd7ab3 Mon Sep 17 00:00:00 2001
From: anamanica <ana@manica.org>
Date: Wed, 7 Aug 2024 15:49:26 -0600
Subject: [PATCH] packet_file_to_datasets *NOT* in IDEX (#743)

* Adding notes in docstring to establish it won't work for IDEX.
---
 imap_processing/utils.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/imap_processing/utils.py b/imap_processing/utils.py
index 12cac4920..01abd6c3b 100644
--- a/imap_processing/utils.py
+++ b/imap_processing/utils.py
@@ -332,6 +332,12 @@ def packet_file_to_datasets(
     -------
     datasets : dict
         Mapping from apid to xarray dataset, one dataset per apid.
+
+    Notes
+    -----
+    This function only handles packet definitions with the same variable structure
+    across all packets with the same ApId. For example, this cannot be used for IDEX
+    due to the conditional XML structure defined for their science packet.
     """
     # Set up containers to store our data
     # We are getting a packet file that may contain multiple apids