Add missing notes section

Author: steff456

src/array_api_stubs/_draft/__init__.py

@@ -21,6 +21,4 @@
 __array_api_version__: str = "YYYY.MM"
 """
 String representing the version of the array API specification which the conforming implementation adheres to.
-
-.. versionadded:: 2022.12
 """

src/array_api_stubs/_draft/array_object.py

@@ -139,6 +139,8 @@ def __abs__(self: array, /) -> array:
         .. note::
            Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function :func:`~array_api.abs`.
 
+        Notes
+        -----
 
         .. versionchanged:: 2022.12
             Added complex data type support.
@@ -160,6 +162,8 @@ def __add__(self: array, other: Union[int, float, array], /) -> array:
         out: array
             an array containing the element-wise sums. The returned array must have a data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function :func:`~array_api.add`.
@@ -337,6 +341,9 @@ def __dlpack__(
             errors are raised when export fails for other reasons (e.g., incorrect
             arguments passed or out of memory).
 
+        Notes
+        -----
+
         .. versionchanged:: 2022.12
             Added BufferError.
         """
@@ -690,6 +697,8 @@ def __matmul__(self: array, other: array, /) -> array:
             -   if either ``self`` or ``other`` has more than two dimensions, an array having a shape determined by :ref:`broadcasting` ``shape(self)[:-2]`` against ``shape(other)[:-2]`` and containing the `conventional matrix product <https://en.wikipedia.org/wiki/Matrix_multiplication>`_ for each stacked matrix.
             -   The returned array must have a data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Results must equal the results returned by the equivalent function :func:`~array_api.matmul`.
@@ -749,6 +758,8 @@ def __mul__(self: array, other: Union[int, float, array], /) -> array:
         out: array
             an array containing the element-wise products. The returned array must have a data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function :func:`~array_api.multiply`.
@@ -774,6 +785,9 @@ def __ne__(self: array, other: Union[int, float, bool, array], /) -> array:
             an array containing the element-wise results. The returned array must have a data type of ``bool`` (i.e., must be a boolean array).
 
 
+        Notes
+        -----
+
         .. note::
            Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function :func:`~array_api.not_equal`.
 
@@ -801,6 +815,8 @@ def __neg__(self: array, /) -> array:
         out: array
             an array containing the evaluated result for each element in ``self``. The returned array must have a data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.negative`.
@@ -844,6 +860,8 @@ def __pos__(self: array, /) -> array:
         out: array
             an array containing the evaluated result for each element. The returned array must have the same data type as ``self``.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.positive`.
@@ -873,6 +891,8 @@ def __pow__(self: array, other: Union[int, float, array], /) -> array:
         out: array
             an array containing the element-wise results. The returned array must have a data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function :func:`~array_api.pow`.
@@ -950,6 +970,8 @@ def __sub__(self: array, other: Union[int, float, array], /) -> array:
         out: array
             an array containing the element-wise differences. The returned array must have a data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results must equal the results returned by the equivalent element-wise function :func:`~array_api.subtract`.
@@ -979,6 +1001,8 @@ def __truediv__(self: array, other: Union[int, float, array], /) -> array:
         out: array
             an array containing the element-wise results. The returned array should have a floating-point data type determined by :ref:`type-promotion`.
 
+        Notes
+        -----
 
         .. note::
            Element-wise results, including special cases, must equal the results returned by the equivalent element-wise function :func:`~array_api.divide`.

src/array_api_stubs/_draft/data_type_functions.py

@@ -37,6 +37,9 @@ def astype(x: array, dtype: dtype, /, *, copy: bool = True) -> array:
     out: array
         an array having the specified data type. The returned array must have the same shape as ``x``.
 
+    Notes
+    -----
+
     .. versionchanged:: 2022.12
        Added complex data type support.
     """
@@ -103,6 +106,9 @@ def finfo(type: Union[dtype, array], /) -> finfo_object:
 
           .. versionadded:: 2022.12
 
+    Notes
+    -----
+
     .. versionchanged:: 2022.12
        Added complex data type support.
     """
@@ -178,6 +184,9 @@ def isdtype(
     out: bool
         boolean indicating whether a provided dtype is of a specified data type kind.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 

src/array_api_stubs/_draft/elementwise_functions.py

@@ -734,6 +734,9 @@ def conj(x: array, /) -> array:
     out: array
         an array containing the element-wise results. The returned array must have the same data type as ``x``.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -1237,6 +1240,9 @@ def imag(x: array, /) -> array:
     out: array
         an array containing the element-wise results. The returned array must have a floating-point data type with the same floating-point precision as ``x`` (e.g., if ``x`` is ``complex64``, the returned array must have the floating-point data type ``float32``).
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -1796,6 +1802,9 @@ def negative(x: array, /) -> array:
     out: array
         an array containing the evaluated result for each element in ``x``. The returned array must have a data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionchanged:: 2022.12
        Added complex data type support.
     """
@@ -1857,6 +1866,9 @@ def positive(x: array, /) -> array:
     out: array
         an array containing the evaluated result for each element in ``x``. The returned array must have the same data type as ``x``.
 
+    Notes
+    -----
+
     .. versionchanged:: 2022.12
        Added complex data type support.
     """
@@ -1946,6 +1958,9 @@ def real(x: array, /) -> array:
     out: array
         an array containing the element-wise results. The returned array must have a floating-point data type with the same floating-point precision as ``x`` (e.g., if ``x`` is ``complex64``, the returned array must have the floating-point data type ``float32``).
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -2312,6 +2327,9 @@ def subtract(x1: array, x2: array, /) -> array:
     out: array
         an array containing the element-wise differences. The returned array must have a data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionchanged:: 2022.12
        Added complex data type support.
     """

src/array_api_stubs/_draft/fft.py

@@ -45,6 +45,9 @@ def fft(
     out: array
         an array transformed along the axis (dimension) indicated by ``axis``. The returned array must have a complex floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -93,6 +96,9 @@ def ifft(
     out: array
         an array transformed along the axis (dimension) indicated by ``axis``. The returned array must have a complex floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -148,6 +154,9 @@ def fftn(
     out: array
         an array transformed along the axes (dimension) indicated by ``axes``. The returned array must have a complex floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -203,6 +212,9 @@ def ifftn(
     out: array
         an array transformed along the axes (dimension) indicated by ``axes``. The returned array must have a complex floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -251,6 +263,9 @@ def rfft(
     out: array
         an array transformed along the axis (dimension) indicated by ``axis``. The returned array must have a complex-valued floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -299,6 +314,9 @@ def irfft(
     out: array
         an array transformed along the axis (dimension) indicated by ``axis``. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`. The length along the transformed axis is ``n`` (if given) or ``2*(m-1)`` (otherwise).
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -354,6 +372,9 @@ def rfftn(
     out: array
         an array transformed along the axes (dimension) indicated by ``axes``. The returned array must have a complex-valued floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -409,6 +430,9 @@ def irfftn(
     out: array
         an array transformed along the axes (dimension) indicated by ``axes``. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`. The length along the last transformed axis is ``s[-1]`` (if given) or ``2*(m - 1)`` (otherwise), and all other axes ``s[i]``.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -454,6 +478,9 @@ def hfft(
     out: array
         an array transformed along the axis (dimension) indicated by ``axis``. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -499,6 +526,9 @@ def ihfft(
     out: array
         an array transformed along the axis (dimension) indicated by ``axis``. The returned array must have a complex-valued floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -528,6 +558,9 @@ def fftfreq(n: int, /, *, d: float = 1.0, device: Optional[device] = None) -> ar
     out: array
         an array of length ``n`` containing the sample frequencies. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -559,6 +592,9 @@ def rfftfreq(n: int, /, *, d: float = 1.0, device: Optional[device] = None) -> a
     out: array
         an array of length ``n//2+1`` containing the sample frequencies. The returned array must have a real-valued floating-point data type determined by :ref:`type-promotion`.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -584,6 +620,9 @@ def fftshift(x: array, /, *, axes: Union[int, Sequence[int]] = None) -> array:
     out: array
         the shifted array. The returned array must have the same data type as ``x``.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 
@@ -607,6 +646,9 @@ def ifftshift(x: array, /, *, axes: Union[int, Sequence[int]] = None) -> array:
     out: array
         the shifted array. The returned array must have the same data type as ``x``.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """
 

src/array_api_stubs/_draft/indexing_functions.py

@@ -24,6 +24,9 @@ def take(x: array, indices: array, /, *, axis: int) -> array:
     out: array
         an array having the same data type as ``x``. The output array must have the same rank (i.e., number of dimensions) as ``x`` and must have the same shape as ``x``, except for the axis specified by ``axis`` whose size must equal the number of elements in ``indices``.
 
+    Notes
+    -----
+
     .. versionadded:: 2022.12
     """