Update return code documentation to reflect enum implementation #797
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…#734) - Update retcode documentation to explain they are now enum values, not symbols - Add proper usage example with SciMLBase.successful_retcode(sol) - Add warning about deprecated sol.retcode == :Success pattern - Fix incorrect usage in FAQ (was sol.retcode, should be just sol) - Add link to SciMLBase ReturnCode documentation for complete reference This addresses the issue where the documentation was outdated and still described return codes as symbols instead of the current enum implementation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
ChrisRackauckas
commented
Jul 23, 2025
ChrisRackauckas
commented
Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the return code (retcode) documentation to reflect the current enum-based implementation instead of the outdated symbol-based approach.
Changes
docs/src/basics/solution.mdto explain that return codes are now enum valuesSciMLBase.successful_retcode(sol)sol.retcode == :Successpatterndocs/src/basics/faq.md(was passingsol.retcode, should be justsol)Context
As pointed out in issue #734, the documentation was outdated and still described return codes as symbols (e.g.,
:Success) when they are now implemented as an enum using EnumX.jl.Example
The documentation now shows the correct way to check for successful solutions:
Fixes #734
🤖 Generated with Claude Code