From fad04062d20414d8526d06384cda4aeaf82cac52 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Mustafa=20A=C4=9Fg=C3=BCl?=
 <33010171+maggul@users.noreply.github.com>
Date: Sun, 20 Oct 2024 00:45:43 +0000
Subject: [PATCH] comment on ARK_RETRY_STEP

---
 src/arkode/arkode.c | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/src/arkode/arkode.c b/src/arkode/arkode.c
index 59bdfa803a..8012844cd1 100644
--- a/src/arkode/arkode.c
+++ b/src/arkode/arkode.c
@@ -3002,10 +3002,12 @@ int arkCheckConvergence(ARKodeMem ark_mem, int* nflagPtr, int* ncfPtr)
   ARKodeHAdaptMem hadapt_mem;
 
   if (*nflagPtr == ARK_SUCCESS) { return (ARK_SUCCESS); }
-  /* Returns with an ARK_RETRY_STEP flag happen in a step much 
-  before any algebraic solvers involve. For this reason, we
-  immediately return form arkCheckConvergence since it is 
-  irrelevant in an ARK_RETRY_STEP case */
+  /* Returns with an ARK_RETRY_STEP flag occur at a stage well before 
+  any algebraic solvers are involved. On the other hand, 
+  the arkCheckConvergence function handles the results from algebraic 
+  solvers, which never take place with an ARK_RETRY_STEP flag. 
+  Therefore, we immediately return from arkCheckConvergence, 
+  as it is irrelevant in the case of an ARK_RETRY_STEP */
   if (*nflagPtr == ARK_RETRY_STEP) { return (ARK_RETRY_STEP); }
 
   /* The nonlinear soln. failed; increment ncfn */