Trust Region docstrings improvement #197
Conversation
docstring update
Codecov Report
@@ Coverage Diff @@
## master #197 +/- ##
==========================================
+ Coverage 91.64% 93.73% +2.08%
==========================================
Files 7 7
Lines 718 718
==========================================
+ Hits 658 673 +15
+ Misses 60 45 -15
... and 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
yash2798
changed the title
yash2798
changed the title
|
@ChrisRackauckas this can be merged |
src/trustRegion.jl
Outdated
| @@ -88,6 +85,14 @@ for large-scale and numerically-difficult nonlinear systems. | |||
| Currently, the linear solver and chunk size choice only applies to in-place defined | |||
| `NonlinearProblem`s. That is expected to change in the future. | |||
| """ | |||
| EnumX.@enumx RadiusUpdateSchemes begin | |||
There was a problem hiding this comment.
why was this moved? This puts the docstrong on the wrong object.
There was a problem hiding this comment.
Umm right now I dont see the trust region docstring on the main docs: https://docs.sciml.ai/NonlinearSolve/stable/api/nonlinearsolve/ . I thought it is because the docstring is not at the beginning.
There was a problem hiding this comment.
So should the Enum definition be on the main src/NonlinearSolve.jl file instead?
There was a problem hiding this comment.
It's because the docstring wasn't right before the function. It has to be exactly the line before the function definition, no space.
There was a problem hiding this comment.
It's already working on the dev version: https://docs.sciml.ai/NonlinearSolve/dev/api/nonlinearsolve/
No description provided.