add notes about parent dataframes

Author: MarcoGorelli

spec/API_specification/dataframe_api/column_object.py

@@ -238,6 +238,11 @@ def __eq__(self, other: Self | Scalar) -> Self:  # type: ignore[override]
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -257,6 +262,11 @@ def __ne__(self, other: Self | Scalar) -> Self:  # type: ignore[override]
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -274,6 +284,11 @@ def __ge__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -291,6 +306,11 @@ def __gt__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -308,6 +328,11 @@ def __le__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -325,6 +350,11 @@ def __lt__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -343,6 +373,11 @@ def __and__(self, other: Self | bool) -> Self:
         -------
         Column
 
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
+
         Raises
         ------
         ValueError
@@ -365,6 +400,11 @@ def __or__(self, other: Self | bool) -> Self:
         -------
         Column
 
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
+
         Raises
         ------
         ValueError
@@ -382,6 +422,11 @@ def __add__(self, other: Self | Scalar) -> Self:
             If Column, must have same length.
             "Scalar" here is defined implicitly by what scalar types are allowed
             for the operation by the underling dtypes.
+ 
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
 
         Returns
         -------
@@ -403,6 +448,11 @@ def __sub__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -420,6 +470,11 @@ def __mul__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -437,6 +492,11 @@ def __truediv__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -454,6 +514,11 @@ def __floordiv__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -475,6 +540,11 @@ def __pow__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -492,6 +562,11 @@ def __mod__(self, other: Self | Scalar) -> Self:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...
 
@@ -509,6 +584,11 @@ def __divmod__(self, other: Self | Scalar) -> tuple[Column, Column]:
         Returns
         -------
         Column
+
+        Notes
+        -----
+        `other`'s parent DataFrame must be the same as `self`'s - else,
+        the operation is unsupported and may vary across implementations.
         """
         ...