Add a note for groebner_apply! documentation

To clarify that groebner_apply! may not work well with Ctrl+C.
sumiya11 · Nov 7, 2024 · 545ec1d · 545ec1d
1 parent b0a3781
commit 545ec1d
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/interface.jl b/src/interface.jl
@@ -354,6 +354,10 @@ For examples, see the documentation of `groebner_learn`.
 ## Notes
 
 This function is **not** thread-safe, since it mutates the `trace`.
+
+This function is **not** safe against program interruptions.
+For example, pressing `Ctrl + C` while `groebner_apply!(trace, ...)` is
+running may leave the `trace` corrupted.
 """
 function groebner_apply! end