Improve JointEq error message for second-order ODEs and add documentation #798
+287
−38
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.
Users implementing second-order ODE systems (e.g., Jansen-Rit neural mass model) encountered a cryptic error when using
JointEq: "Variable 'y3' has been used... Please change another name." The actual issue was incorrect function signature ordering, not a naming conflict.Changes
Error Message Enhancement
tare state variables; parameters aftertare dependenciestin exactly one derivative functionDocumentation
joint_equations.ipynbcovering second-order ODE systemsTests
test_second_order_odefor harmonic oscillator validationtest_second_order_ode_wrong_signatureto verify improved error messagingExample
Incorrect (from original issue):
Correct:
The new error message shows the current function signature and pattern guidance when this mistake occurs.
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.