make some playing with debugging.

Author: JoeZiminski

src/spikeinterface/generation/debugging/debugging_session_displacement.py

@@ -54,7 +54,7 @@
 
 rec_list, _ = generate_inter_session_displacement_recordings(
     non_rigid_gradient=None,  # 0.05,
-    num_units=5,
+    num_units=1,
     rec_durations=(25, 25, 25),  # TODO: checks on inputs
     rec_shifts=(
         0,
@@ -102,3 +102,15 @@
 # TODO: I think it is OK when it goes over the edge, just need to check explicitly what happens.
 # It will be greater than margin, etc. Is it explicitly clipped or just allowed to go outside of range?
 # I guess this will ignore the margin. That's fine. I think here is it just going outside of range.
+
+
+# Tests plan
+
+# 1) when generated with zero shift, this should be the same as GenerateTemplate!
+# 2) Generate with a single shift. The templates should be identical
+#    across all records. The only thing that should be different is
+#    the unit locations parameter. It should be on the recording and sorting.
+#    test both rigid and nonrigid. Test the unit locations exactly.
+# 3) try generating with multiple shifts.
+# 4) Do like 1 unit, find peak and peak locations. Check the avg moves as expected!
+# 5) check durations, check all new input arguments.