Skip to content

DOC: clarify wording in quickstart ix_() section#31149

Merged
ngoldbaum merged 1 commit intonumpy:mainfrom
agp19d:doc/fix-quickstart-ix-wording
Apr 9, 2026
Merged

DOC: clarify wording in quickstart ix_() section#31149
ngoldbaum merged 1 commit intonumpy:mainfrom
agp19d:doc/fix-quickstart-ix-wording

Conversation

@agp19d
Copy link
Copy Markdown
Contributor

@agp19d agp19d commented Apr 4, 2026

PR summary

Clarifies a confusing sentence in the "The ix_() function" section of the
NumPy quickstart tutorial.

The original wording — "creating an argument array the size of the output
times the number of vectors" — was reported as unclear by a user learning
from the quickstart. This rewording follows the suggestion from @ngoldbaum
in the issue discussion.

Closes #31127

First time committer introduction

Hi! I'm Alejandro Garcia de Paredes, a code enthusiast with a background in data science, data engineering, and AI engineering. I'm looking to contribute to open source projects and this one caught my attention. Happy to receive feedback and iterate on my contribution.

AI Disclosure

No AI tools used.

The original sentence "creating an argument array the size of the output
times the number of vectors" was confusing. Reworded to be clearer about
the memory advantage of using broadcasting with ix_().

Closes numpy#31127
@ngoldbaum
Copy link
Copy Markdown
Member

LGTM, clearly an improvement.

@ngoldbaum ngoldbaum merged commit 6dfe60e into numpy:main Apr 9, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Missing words in the "NumPy quickstart"

2 participants