clarify eigen docstring #1364
Merged
clarify eigen docstring #1364
Conversation
This file contains hidden or 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
jishnub
approved these changes
May 28, 2025
jishnub
pushed a commit
that referenced
this pull request
Jun 5, 2025
jishnub
added a commit
that referenced
this pull request
Jun 13, 2025
Backported PRs: - [x] #1364 <!-- clarify eigen docstring --> - [x] #1363 <!-- Change default symmetriceigen algorithm back to RobustRepresentations --> Non-merged PRs with backport label: - [ ] #1365 <!-- Add docstring to the `rank(::QRPivoted)` method --> - [ ] #1305 <!-- Bounds-checking in triangular indexing branches -->
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.
Closes #1174
eigenis in fact guaranteed to return normalized eigenvectors in the general case, and orthonormal eigenvectors in the Hermitian case, and the docstring should state so.