DOC: Clarify that 'names' is only used when constructing a MultiIndex #61619
+10
−0
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
| >>> pd.Index([], name='a').name | ||
| 'a' | ||
|
|
||
| >>> pd.Index([], names=['a']).name is None |
There was a problem hiding this comment.
Those seem like a test more than an example. And I don't see names as a parameter of Index: https://pandas.pydata.org/docs/dev/reference/indexing.html#index
I guess the issue is outdated, it's from 2018, and last comment confirms.
|
I'll close this PR as it doesn't feel useful. Feel free to comment if I'm missing something, and I can surely reopen. |
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.
namesnames argument, doesn't set index name #19082(Not applicable — this is a documentation-only change)
(Not applicable — no new functions or arguments were added)
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature(Optional — this change may be too minor, but can be added under "Documentation" if desired)
Description
Clarifies in the
Indexclass docstring that thenamesparameter is only relevant when constructing aMultiIndex. This prevents confusion where users expectnames=('a',)to behave likename='a'for regular Index objects.No changes were made to the behavior of
Index, only to the documentation for better clarity.