Added missing iiter and xnorm to the documentation of pylops.lsqr
#638
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
**Issue [Documentation] `pylops.lsqr` documentation lists 9 results even though there is 11 PyLops#637** - added `iiter` and `xnorm` to the documentation of the `pylops.lsqr` solver and related methods
|
@IruNikZe thanks for noticing this, the PR looks great. I approve it :) |
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.
The documentation of pylops.lsqr was missing the returns of
iiterandxnorm.They were added to the docs of all related functions and methods.
For
iiterthe same phrasing as forscipy.sparse.linalg.lsqrwas used.For
xnorm, the mathematical style ofpylopswas adopted.Closes #637