Simpler first README example, also ref to Roots.jl. Fixes #264. #271
Conversation
This file contains 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
|
Thanks. |
Codecov Report
@@ Coverage Diff @@
## master #271 +/- ##
==========================================
+ Coverage 87.57% 88.12% +0.55%
==========================================
Files 12 12
Lines 531 556 +25
==========================================
+ Hits 465 490 +25
Misses 66 66
Continue to review full report at Codecov.
|
|
Reference to NonlinearSolve.jl as a non-allocating version of Roots.jl? |
|
Ok, I added that reference as a second commit. As stated over in #264, a full summary of what package to use when would be good, but in another PR. |
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.
Whilst I've used a few bells and whistles of the excellent NLsolve, most of the time I just quickly want to solve a system of nl equations without any thoughts about performance. This now shows this as the top-most example in the README. Issue #264 suggests that at least one more person would appreciate a simpler first example (I also added the reference to Roots.jl).