move docstring to the public interface

Author: corentinmusard

tilebox-datasets/tilebox/datasets/aio/client.py

@@ -40,19 +40,40 @@ async def create_dataset(
         fields: list[FieldDict],
         *,
         name: str | None = None,
-        summary: str | None = None,
+        description: str | None = None,
     ) -> DatasetClient:
+        """Create a new dataset.
+
+        Args:
+            kind: The kind of the dataset.
+            code_name: The code name of the dataset.
+            fields: The fields of the dataset.
+            name: The name of the dataset. Defaults to the code name.
+            description: A short description of the dataset. Optional.
+
+        Returns:
+            The created dataset.
+        """
         if name is None:
             name = code_name
-        if summary is None:
-            summary = ""
+        if description is None:
+            description = ""
 
-        return await self._client.create_dataset(kind, code_name, fields, name, summary, DatasetClient)
+        return await self._client.create_dataset(kind, code_name, fields, name, description, DatasetClient)
 
     async def datasets(self) -> Group:
+        """Fetch all available datasets."""
         return await self._client.datasets(DatasetClient)
 
     async def dataset(self, slug: str) -> DatasetClient:
+        """Get a dataset by its slug, e.g. `open_data.copernicus.sentinel1_sar`.
+
+        Args:
+            slug: The slug of the dataset.
+
+        Returns:
+            The dataset if it exists.
+        """
         return await self._client.dataset(slug, DatasetClient)
 
     async def _dataset_by_id(self, dataset_id: str | UUID) -> DatasetClient:

tilebox-datasets/tilebox/datasets/client.py

@@ -29,26 +29,13 @@ def __init__(self, service: TileboxDatasetService) -> None:
     def create_dataset(  # noqa: PLR0913
         self, kind: DatasetKind, code_name: str, fields: list[FieldDict], name: str, summary: str, dataset_type: type[T]
     ) -> Promise[T]:
-        """Create a new dataset.
-
-        Args:
-            kind: The kind of the dataset.
-            code_name: The code name of the dataset.
-            fields: The fields of the dataset.
-            name: The name of the dataset. Defaults to the code name.
-            summary: A short summary of the dataset. Optional.
-
-        Returns:
-            The created dataset.
-        """
         return (
             self._service.create_dataset(kind, code_name, fields, name, summary)
             .then(_ensure_registered)
             .then(lambda dataset: dataset_type(self._service, dataset))
         )
 
     def datasets(self, dataset_type: type[T]) -> Promise[Group]:
-        """Fetch all available datasets."""
         return (
             self._service.list_datasets()
             .then(_log_server_message)
@@ -61,15 +48,6 @@ def datasets(self, dataset_type: type[T]) -> Promise[Group]:
         )
 
     def dataset(self, slug: str, dataset_type: type[T]) -> Promise[T]:
-        """Get a dataset by its slug, e.g. `open_data.copernicus.sentinel1_sar`.
-
-        Args:
-            slug: The slug of the dataset.
-
-        Returns:
-            The dataset if it exists.
-        """
-
         return (
             self._service.get_dataset_by_slug(slug)
             .then(_ensure_registered)

tilebox-datasets/tilebox/datasets/sync/client.py

@@ -40,19 +40,40 @@ def create_dataset(
         fields: list[FieldDict],
         *,
         name: str | None = None,
-        summary: str | None = None,
+        description: str | None = None,
     ) -> DatasetClient:
+        """Create a new dataset.
+
+        Args:
+            kind: The kind of the dataset.
+            code_name: The code name of the dataset.
+            fields: The fields of the dataset.
+            name: The name of the dataset. Defaults to the code name.
+            description: A short description of the dataset. Optional.
+
+        Returns:
+            The created dataset.
+        """
         if name is None:
             name = code_name
-        if summary is None:
-            summary = ""
+        if description is None:
+            description = ""
 
-        return self._client.create_dataset(kind, code_name, fields, name, summary, DatasetClient).get()
+        return self._client.create_dataset(kind, code_name, fields, name, description, DatasetClient).get()
 
     def datasets(self) -> Group:
+        """Fetch all available datasets."""
         return self._client.datasets(DatasetClient).get()
 
     def dataset(self, slug: str) -> DatasetClient:
+        """Get a dataset by its slug, e.g. `open_data.copernicus.sentinel1_sar`.
+
+        Args:
+            slug: The slug of the dataset.
+
+        Returns:
+            The dataset if it exists.
+        """
         return self._client.dataset(slug, DatasetClient).get()
 
     def _dataset_by_id(self, dataset_id: str | UUID) -> DatasetClient: