start fixing LinearProblem docstring #351
Open
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
Codecov Report
@@ Coverage Diff @@
## master #351 +/- ##
==========================================
+ Coverage 57.92% 57.98% +0.06%
==========================================
Files 43 43
Lines 3289 3289
==========================================
+ Hits 1905 1907 +2
+ Misses 1384 1382 -2
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
src/problems/basic_problems.jl
Outdated
| @@ -32,8 +32,8 @@ Optionally, an initial guess ``u₀`` can be supplied which is used for iterativ | |||
| methods. | |||
|
|
|||
| ```julia | |||
| LinearProblem{isinplace}(A,x,p=NullParameters();u0=nothing,kwargs...) | |||
| LinearProblem(f::AbstractDiffEqOperator,u0,p=NullParameters();u0=nothing,kwargs...) | |||
| LinearProblem(A,b;u0=nothing,kwargs...) | |||
There was a problem hiding this comment.
If you are passing a matrix, why would this need parameters?
Parameters should only be there when you work with the Operator interface?
src/problems/basic_problems.jl
Outdated
| LinearProblem{isinplace}(A,x,p=NullParameters();u0=nothing,kwargs...) | ||
| LinearProblem(f::AbstractDiffEqOperator,u0,p=NullParameters();u0=nothing,kwargs...) | ||
| LinearProblem(A,b;u0=nothing,kwargs...) | ||
| LinearProblem{isinplace}(f::AbstractSciMLOperator,b,p=NullParameters();u0=nothing,kwargs...) |
There was a problem hiding this comment.
The surrounding text all mention SciMLOperator, not DiffEqOperator.
| @@ -18,7 +18,7 @@ Au = b | |||
|
|
|||
| For matrix-free versions, the specification of the problem is given by an | |||
| operator `A(u,p,t)` which computes `A*u`, or in-place as `A(du,u,p,t)`. These | |||
| are specified via the `AbstractSciMLOperator` interface. For more details, see | |||
| are specified via the `AbstractDiffEqOperator` interface. For more details, see | |||
There was a problem hiding this comment.
We should just keep it to SciMLOperators as we plan to finish it ASAP
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.
There is still something more wrong with
u0, it is used both as positional and keyword argument.