ST_SetStimsetParameter: Mention specialities for MID_SWEEP_EVENT

Close #1094
AllenInstitute · Jan 28, 2025 · a486525 · a486525
1 parent d70cc01
commit a486525
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/Packages/MIES/MIES_StimsetAPI.ipf b/Packages/MIES/MIES_StimsetAPI.ipf
@@ -409,7 +409,8 @@ End
 ///
 /// If you use this function in analysis functions be sure to use an event which happens *before* the stimset is read,
 /// for example `PRE_DAQ_EVENT`, `PRE_SET_EVENT` or `PRE_SWEEP_CONFIG_EVENT`. The last one is always called for each
-/// sweep before it is configured.
+/// sweep before it is configured. This also means that if you change a stimset during `MID_SWEEP_EVENT` the changes
+/// will not be picked up for the current sweep.
 ///
 /// @param setName    name of the stimset
 /// @param entry      name of the parameter, can be global or epoch