DOC: clarify residual in np.polyfit #14629
Conversation
| Present only if `full` = True. Residuals is sum of squared residuals | ||
| of the least-squares fit, the effective rank of the scaled Vandermonde | ||
| coefficient matrix, its singular values, and the specified value of | ||
| `rcond`. For more details, see `linalg.lstsq`. |
There was a problem hiding this comment.
@mattip - these attempted links to parameters should raise sphinx warnings, and ideally the docs build test should fail on those?
There was a problem hiding this comment.
Oh, right, indeed. I assumed without much thinking that this was turned on already, sorry for the noise then.
If an extra pair of hand would help, let me know, messing with sphinx is well within my comfort zone.
There was a problem hiding this comment.
a review of #14699 would be helpful, and continuation of the work would be great
There was a problem hiding this comment.
These shouldn't raise warnings, usage is correct here. At least, this is what the numpydoc spec says. And the rendering can be controlled, see numpy/numpydoc#233
|
Merged, thanks @sethtroisi |
Closes #7213
wording matches
resid -- sum of squared residuals of the least squares fitwhich is present in several files (polynomial.py, _polybase.py, hermite.py, ...)