Improve progress bar docstring with VS Code setup link #1204
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
Added reference to progress bar setup documentation in the Progress Monitoring section of the solve() docstring. This addresses issue SciML#1198 where users need to know how to properly set up progress bars in VS Code and other environments when using progress=true. The link points to the specific section in the SciML documentation that explains how to use ProgressLogging.jl with VS Code and other environments. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
solve()docstringprogress=trueis broken, no longer displaying anything #1198 where users need guidance on setting up progress bars in VS Code and other environmentsBackground
Issue #1198 reported that
progress=truewasn't displaying anything, and the solution was to use ProgressLogging.jl as documented. The request was made to add this link to the solver keyword descriptions to help users find the setup information more easily.Changes
src/solve.jlto include a link to https://docs.sciml.ai/DiffEqDocs/stable/features/progress_bar/#Using-Progress-Bars-with-VS-Code in the Progress Monitoring sectionTest Plan
julia --project=. -e 'using Pkg; Pkg.activate("."); Pkg.test()'- all tests pass🤖 Generated with Claude Code