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 12 commits into
base: main
Choose a base branch
from
4 changes: 3 additions & 1 deletion doc/source/user_guide/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,9 @@ 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?

Copy link
Author

Choose a reason for hiding this comment

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

Done with changes

.. ipython:: python

df.add(np.array([1, 2, 3]), axis=0)

.. ipython:: python

Expand Down
7 changes: 7 additions & 0 deletions doc/source/user_guide/dsintro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -650,6 +650,13 @@ row-wise. For example:

df - df.iloc[0]

Use .add(array, axis=0) to apply row-wise broadcasting when the array length matches the number of rows —
this ensures element-wise operations are performed across each row, rather than mistakenly aligning with columns.

.. ipython:: python

df.add(np.array([1, 2, 3]), axis=0)

For explicit control over the matching and broadcasting behavior, see the
section on :ref:`flexible binary operations <basics.binop>`.

Expand Down
Loading