DOC: Fix documentation bugs in lstsq
#14852
Merged
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
ilayn
reviewed
Oct 13, 2021
There was a problem hiding this comment.
@stephenbeckr Thanks a lot! All good with one minor comment.
ilayn
added
the
Documentation
Documentation was incorrectly copied from numpy.linalg? Suggested changes: 1. References `rcond` when it should reference just `cond` (`rcond` is the term used in numpy) 2. Remove absolute values in the "The condition number is..." since singular values are always non-negative 3. Update the description of the size of `x` to match the numpy documentation. `x` is *not* the same shape as `b` unless M=N.
|
Merged, thanks @stephenbeckr and @ilayn |
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.
What does this implement/fix?
Found errors in documentation. Documentation was incorrectly copied from numpy.linalg?
What does this implement/fix?
rcondwhen it should reference justcond(rcondis the term used in numpy)xto match the numpy documentation.xis not the same shape asbunless M=N.Additional information
This is my first pull request, please excuse me if I used the wrong branch or other mistake.