Skip to content

Commit c4dfcce

Browse files
Update docs/src/basics/solution.md
1 parent 9c22374 commit c4dfcce

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

docs/src/basics/solution.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,9 @@ SciMLBase.successful_retcode(sol)
192192

193193
!!! warning
194194
Previous iterations of the interface suggested using `sol.retcode == :Success`,
195-
however, that is now not advised. Use `SciMLBase.successful_retcode(sol)` instead.
195+
however, that is now not advised because there are more than one return code that can be interpreted
196+
as successful. For example, `Terminated` is a successful run to a manual termination, and would be missed
197+
if only checking for Success. Therefore we highly recommend you use `SciMLBase.successful_retcode(sol)` instead.
196198

197199
The return codes include:
198200

0 commit comments

Comments
 (0)