diff --git a/spec/API_specification/dataframe_api/column_object.py b/spec/API_specification/dataframe_api/column_object.py index 6a83bbce..59efa106 100644 --- a/spec/API_specification/dataframe_api/column_object.py +++ b/spec/API_specification/dataframe_api/column_object.py @@ -201,6 +201,12 @@ def __eq__(self, other: Self | Scalar) -> Self: # type: ignore[override] Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -219,6 +225,12 @@ def __ne__(self, other: Self | Scalar) -> Self: # type: ignore[override] Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -235,6 +247,12 @@ def __ge__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -251,6 +269,12 @@ def __gt__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -267,6 +291,12 @@ def __le__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -283,6 +313,12 @@ def __lt__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -304,6 +340,12 @@ def __and__(self, other: Self | bool) -> Self: ------ ValueError If `self` or `other` is not boolean. + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -325,6 +367,12 @@ def __or__(self, other: Self | bool) -> Self: ------ ValueError If `self` or `other` is not boolean. + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -341,6 +389,12 @@ def __add__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -357,6 +411,12 @@ def __sub__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -373,6 +433,12 @@ def __mul__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -389,6 +455,12 @@ def __truediv__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -405,6 +477,12 @@ def __floordiv__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -425,6 +503,12 @@ def __pow__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -441,6 +525,12 @@ def __mod__(self, other: Self | Scalar) -> Self: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -457,6 +547,12 @@ def __divmod__(self, other: Self | Scalar) -> tuple[Column, Column]: Returns ------- Column + + Notes + ----- + If `other` is a `Column`, then the Standard only supports the case when `other` + and `self` originated from the same dataframe. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ... diff --git a/spec/API_specification/dataframe_api/dataframe_object.py b/spec/API_specification/dataframe_api/dataframe_object.py index 359171bb..283e1b3b 100644 --- a/spec/API_specification/dataframe_api/dataframe_object.py +++ b/spec/API_specification/dataframe_api/dataframe_object.py @@ -136,6 +136,12 @@ def get_rows(self, indices: Column) -> Self: Returns ------- DataFrame + + Notes + ----- + The Standard only supports the case when `indices` + originated from `self`. If it didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -172,8 +178,9 @@ def filter(self, mask: Column) -> Self: Notes ----- - Some participants preferred a weaker type Arraylike[bool] for mask, - where 'Arraylike' denotes an object adhering to the Array API standard. + The Standard only supports the case when `mask` + originated from `self`. If it didn't, then behaviour + is unspecified and may vary across implementations. """ ... @@ -201,6 +208,12 @@ def assign(self, *columns: Column) -> Self: Returns ------- DataFrame + + Notes + ----- + The Standard only supports the case when `columns` + originated from `self`. If they didn't, then behaviour + is unspecified and may vary across implementations. """ ...