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

Documentation Request: Clarity for __matmul__ operator #9023

Closed
mthramann opened this issue May 10, 2024 · 3 comments · Fixed by #9060
Closed

Documentation Request: Clarity for __matmul__ operator #9023

mthramann opened this issue May 10, 2024 · 3 comments · Fixed by #9060

Comments

@mthramann
Copy link
Contributor

What is your issue?

Currently the matmul documentation states that the operator does "matrix multiplication". It's unclear if this means np.matmul semantics, or xr.dot.

It's probably worth explicitly calling out the distinction inline between np.matmul and np.dot, with a short explanation why this isn't the np.matmul behavior.

@mthramann mthramann added the needs triage Issue that has not been reviewed by xarray team member label May 10, 2024
Copy link

welcome bot commented May 10, 2024

Thanks for opening your first issue here at xarray! Be sure to follow the issue template!
If you have an idea for a solution, we would really welcome a Pull Request with proposed changes.
See the Contributing Guide for more.
It may take us a while to respond here, but we really value your contribution. Contributors like you help make xarray better.
Thank you!

@mthramann mthramann changed the title Improve documentation for __matmul__ operator Documentation Request: Clarity for __matmul__ operator May 10, 2024
@TomNicholas TomNicholas added topic-documentation and removed needs triage Issue that has not been reviewed by xarray team member labels May 11, 2024
@TomNicholas
Copy link
Contributor

Thanks for pointing this out @mthramann ! We would happily accept a PR to clarify this :)

@kmuehlbauer
Copy link
Contributor

fixed by #9060

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants