Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix reference to eigh/eigvalsh #838

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Conversation

mdhaber
Copy link
Contributor

@mdhaber mdhaber commented Aug 26, 2024

The linear algebra extension specification refers to eig/eigvals as an example of dedicated interfaces rather than a single interface with polymorphic return type.

eig/eigvals are not yet in the standard, so this PR replaces these references with eigh/eigvalsh.

(I went ahead and changed the 202x.12 versions in addition to draft; if that's not right, it should be easy to revert them.)

Copy link
Contributor

@kgryte kgryte left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks, @mdhaber!

@kgryte kgryte added Narrative Content Narrative documentation content. topic: Linear Algebra Linear algebra. Backport Changes involve backporting to previous versions. labels Aug 27, 2024
@kgryte kgryte added this to the v2024 milestone Aug 27, 2024
@kgryte kgryte changed the title DOC: change reference from eig/eigvals -> eigh/eigvalsh docs: fix reference to eigh/eigvalsh Aug 27, 2024
@kgryte kgryte merged commit 0cd4bdf into data-apis:main Aug 27, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backport Changes involve backporting to previous versions. Narrative Content Narrative documentation content. topic: Linear Algebra Linear algebra.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants