DOC: Update of 'return_eigenvectors' description #9134
Conversation
Issued by gauthe. #9082.
| @@ -1361,7 +1361,8 @@ def eigsh(A, k=6, M=None, sigma=None, which='LM', v0=None, | |||
| Returns | |||
| ------- | |||
| w : array | |||
| Array of k eigenvalues | |||
| Array of k eigenvalues. | |||
|
|
|||
There was a problem hiding this comment.
We don't need empty lines between the items in the same section.
There was a problem hiding this comment.
Yes, It seems that there is a blank line in editing process. I will correct your point.
|
|
||
| If `return_eigenvectors` is True, eigenvalues are sorted by algebraic value | ||
|
|
||
| If `return_eigenvectors` is False, eigenvalues are sorted by magnitude value |
There was a problem hiding this comment.
The term "absolute value" sounds more natural.
There was a problem hiding this comment.
I agree with you.
Generally speaking, 'absolution' is better that 'magnitude'.
Thanks for your quickly reviews, @ilayn.
Changes that reflect @ilayn reviews.
adding a more detailed which case description
| For which = 'SM': | ||
| If `return_eigenvectors` is True, eigenvalues are sorted by algebraic value | ||
|
|
||
| If `return_eigenvectors` is False, eigenvalues are sorted by decreasing absolute value. |
There was a problem hiding this comment.
punctuation terminates this sentence, but not the ones on lines 1453, 1455, 1458, and 1461.
There was a problem hiding this comment.
I will revise the sentence with a punctuation termination.
|
FWIW, the docstring for the entire method is rampant with inconsistent punctuation. I don't consider that important, but now is not a bad time to make the docstring consistent. |
ilayn
added
scipy.sparse.linalg
Documentation
|
@jeffyancey I agree with you. I'll do more thorough checking and document work. |
Working with a document consistent issued by @jeffyancey.
|
@jeffyancey I fixed docstring consistency for a punctuation terminate. |
| OPinv : N x N matrix, array, sparse matrix, or LinearOperator | ||
| See notes in sigma, above. | ||
| return_eigenvectors : bool | ||
| Return eigenvectors (True) in addition to eigenvalues | ||
| Return eigenvectors (True) in addition to eigenvalues. This value determines | ||
| the order in which eigenvalues are sorted. The sort order is also dependent on the which variable. |
There was a problem hiding this comment.
I fixed your request.
Changed general word to marked as a variable
which is marked as a variable
rgommers
changed the title
|
|
||
| Parameters | ||
| ---------- | ||
| A : An N x N matrix, array, sparse matrix, or LinearOperator representing | ||
| the operation A * x, where A is a real symmetric matrix | ||
| For buckling mode (see below) A must additionally be positive-definite | ||
| the operation A * x, where A is a real symmetric matrix. |
There was a problem hiding this comment.
Asterisks have special meaning in ReST, so should wrap A*x into double backticks.
There was a problem hiding this comment.
Also it's better to use A @ b for matrix multiplication.
- changes asterisks to matrix multiplication operator '@' - wrap A @ x into double backticks
changes matrix multiplication operator '*' into '@'
|
Line 1374 should be |
|
@gauth I forgot that |
|
LGTM now, merging. Thanks @akahard2dj, all. |
Issued by @Gauthe. #9082.