DOC: Replace @appender decorator with inline docstrings for MultiInde… #62780
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
Starlessnightx
force-pushed
the
fix-multi-docstring
branch
2 times, most recently
from
01bb8ca to
80d8560
Compare
…x.take and MultiIndex.repeat
Starlessnightx
force-pushed
the
fix-multi-docstring
branch
from
80d8560 to
dd53f5d
Compare
mroeschke
approved these changes
Oct 22, 2025
|
Thanks @Starlessnightx |
mroeschke
reviewed
Oct 22, 2025
Comment on lines
+2340
to
+2342
| >>> idx = pd.Index(["a", "b", "c"]) | ||
| >>> idx.take([2, 2, 1, 2]) | ||
| Index(['c', 'c', 'b', 'c'], dtype='str') |
There was a problem hiding this comment.
If you're interested in follow with with another PR, could you change these examples to use a MultiIndex instead of an Index
There was a problem hiding this comment.
@mroeschke Thank you for the review! You're absolutely right, these examples should indeed use MultiIndex to better demonstrate the method's functionality.
I've understood what needs to be modified:
- In the examples for both
takeandrepeatmethods, change the regularIndexexamples toMultiIndexexamples
I'll fix these issues in a follow-up PR to ensure the example code uses proper MultiIndex to demonstrate the method usage.
Thanks for the guidance!
Merged
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Remove use of @appender for MultiIndex.take and MultiIndex.repeat
Inlined full docstring directly into the method
Remove useless import
This is part of fix for issue DOC: Replace
@Appender,@Substitution,@docwith inlined docstrings #62437Tests added and passed if fixing a bug or adding a new feature
All code checks passed.
Added type annotations to new arguments/methods/functions.
Added an entry in the latest
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.