Skip to content

DOC: Clarify broadcasting behavior when using lists in DataFrame arithmetic (GH18857) #61820

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.

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Shashwat1001
Copy link

@Shashwat1001 Shashwat1001 commented Jul 9, 2025

  • Clarifies the behavior when using Python lists in arithmetic operations with DataFrames.
  • Adds an example in dsintro.rst to show how adding a list returns a Series of arrays.
  • Adds a note in basics.rst to explain that lists are not broadcasted element-wise, unlike NumPy arrays or Series.
  • Fixes DOC: improve docs for broadcasting behavior #18857.

@Shashwat1001 Shashwat1001 marked this pull request as draft July 9, 2025 18:26
@Shashwat1001 Shashwat1001 marked this pull request as ready for review July 15, 2025 07:55
@@ -209,6 +209,10 @@ either match on the *index* or *columns* via the **axis** keyword:
df.sub(column, axis="index")
df.sub(column, axis=0)

Be careful when using raw Python lists in binary operations with DataFrames.
Copy link
Member

Choose a reason for hiding this comment

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

i dont think this is accurate

Copy link
Author

Choose a reason for hiding this comment

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

Made the changes kept in as same as the other file

@@ -209,7 +209,12 @@ either match on the *index* or *columns* via the **axis** keyword:
df.sub(column, axis="index")
df.sub(column, axis=0)
Furthermore you can align a level of a MultiIndexed DataFrame with a Series.
Copy link
Member

Choose a reason for hiding this comment

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

is this sentence no longer needed?

@@ -209,7 +209,12 @@ either match on the *index* or *columns* via the **axis** keyword:
df.sub(column, axis="index")
df.sub(column, axis=0)
Furthermore you can align a level of a MultiIndexed DataFrame with a Series.
Use .add(array, axis=0) to broadcast values row-wise, ensuring each element in the array is
Copy link
Member

Choose a reason for hiding this comment

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

i thin this is already clear from the example above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: improve docs for broadcasting behavior
3 participants