DOC: Add Examples section to append_fields in numpy.lib.recfunctions#31544
Open
lakshit2234 wants to merge 2 commits into
Open
DOC: Add Examples section to append_fields in numpy.lib.recfunctions#31544lakshit2234 wants to merge 2 commits into
lakshit2234 wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds illustrative usage examples to the append_fields docstring to clarify how to append one or multiple fields to a structured array.
Changes:
- Added a basic example appending a single field to a structured array.
- Added an example demonstrating appending multiple fields in one call.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+684
to
+701
| Examples | ||
| -------- | ||
| >>> import numpy as np | ||
| >>> from numpy.lib.recfunctions import append_fields | ||
| >>> base = np.array([(1, 2.0), (3, 4.0)], dtype=[('x', int), ('y', float)]) | ||
| >>> new_field = np.array([10, 20]) | ||
| >>> append_fields(base, 'z', new_field, usemask=False) | ||
| array([(1, 2., 10), (3, 4., 20)], | ||
| dtype=[('x', '<i4'), ('y', '<f8'), ('z', '<i4')]) | ||
|
|
||
| Append multiple fields at once: | ||
|
|
||
| >>> a = np.array([1, 2, 3]) | ||
| >>> b = np.array([4.0, 5.0, 6.0]) | ||
| >>> base = np.array([(1,), (2,), (3,)], dtype=[('x', int)]) | ||
| >>> append_fields(base, ['a', 'b'], [a, b], usemask=False) | ||
| array([(1, 1, 4.), (2, 2, 5.), (3, 3, 6.)], | ||
| dtype=[('x', '<i4'), ('a', '<i4'), ('b', '<f8')]) |
Member
|
We don't allow copilot reviews. |
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
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.
What this PR does
Added an
Examplessection to theappend_fieldsfunction innumpy/lib/recfunctions.py, which was missing documentation examples.The examples demonstrate:
AI Disclosure
Examples section and suggesting the structure of the docstring example.
was AI-assisted.
by running the code locally. I understand the code fully and take
complete responsibility for this contribution.