Skip to content

DOC: Updated set_index doc with a warning #60990

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Mar 5, 2025
Merged

DOC: Updated set_index doc with a warning #60990

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fde5ed8
Updated set_index doc with a warning
SaraInCode Feb 23, 2025
7281a18
Merge branch 'pandas-dev:main' into no-warning-in-set_index
SaraInCode Mar 2, 2025
fa65ba5
Updated set_index parameter append along with an example
SaraInCode Mar 2, 2025
d053e6c
Updated set_index example for append
SaraInCode Mar 2, 2025
ff0a805
Updated set_index example
SaraInCode Mar 4, 2025
3b2a9b4
Merge branch 'pandas-dev:main' into no-warning-in-set_index
SaraInCode Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5868,6 +5868,10 @@ def set_index(
columns or arrays (of the correct length). The index can replace the
existing index or expand on it.

.. warning::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead, could you show this as an example in the Examples section instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll probably be removing the warning but I could show an example

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mroeschke - good here?

Setting a new index will remove the current index column,
unless you first call `reset_index`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only true when append=False. As mentioned in the issue, this seems to me to be redundant with the line above:

The index can replace the existing index or expand on it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the review. Though it seems redundant with the line you mentioned. When you look at,

append: bool, default False

Whether to append columns to existing index.

it doesn't directly explain the behavior of replacing the existing index (by default). Does this statement makes it clear?

append: bool, default False

Whether to append new columns to the existing index . If set to True, the current index will remain unchanged and new columns will be added.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed we should add something here, but saying it is unchanged and columns are added seems inconsistent to me. I also think the True behavior is already clear by Whether to append new columns to the existing index. However the False behavior could perhaps use elaboration. I would suggest:

When False, the current index will be dropped from the DataFrame.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But not strongly opposed to adding elaboration for the True case either.


Parameters
----------
keys : label or array-like or list of labels/arrays
Expand Down
Loading