move api_version to dataframe_standard (data-apis#206)

MarcoGorelli · web-flow · commit 3fd047f545a1 · 2023-07-26T11:23:15.000+01:00
diff --git a/spec/API_specification/dataframe_api/dataframe_object.py b/spec/API_specification/dataframe_api/dataframe_object.py
@@ -37,21 +37,9 @@ class DataFrame:
     **Methods and Attributes**
 
     """
-    def __dataframe_namespace__(
-        self, /, *, api_version: str | None = None
-    ) -> Any:
+    def __dataframe_namespace__(self) -> Any:
         """
-        Returns an object that has all the dataframe API functions on it.
-
-        Parameters
-        ----------
-        api_version: Optional[str]
-            String representing the version of the dataframe API specification
-            to be returned, in ``'YYYY.MM'`` form, for example, ``'2023.04'``.
-            If it is ``None``, it should return the namespace corresponding to
-            latest version of the dataframe API specification.  If the given
-            version is invalid or not implemented for the given module, an
-            error should be raised. Default: ``None``.
+        Returns an object that has all the top-level dataframe API functions on it.
 
         Returns
         -------
@@ -61,7 +49,6 @@ def __dataframe_namespace__(
             attribute. It may contain other public names as well, but it is
             recommended to only include those names that are part of the
             specification.
-
         """
 
     @property
diff --git a/spec/purpose_and_scope.md b/spec/purpose_and_scope.md
@@ -367,3 +367,20 @@ are required to provide the following methods:
 For example, pandas would have ``pandas.DataFrame.__dataframe_standard__`` and
 ``pandas.Series.__column_standard__``.
 
+The signatures should be (note: docstring is optional):
+```python
+def __dataframe_standard__(
+    self, /, *, api_version: str | None = None
+) -> Any:
+
+def __column_standard__(
+    self, /, *, api_version: str | None = None
+) -> Any:
+```
+`api_version` is
+a string representing the version of the dataframe API specification
+to be returned, in ``'YYYY.MM'`` form, for example, ``'2023.04'``.
+If it is ``None``, it should return the namespace corresponding to
+latest version of the dataframe API specification.  If the given
+version is invalid or not implemented for the given module, an
+error should be raised. Default: ``None``.
