docs: update documentation

CS-SI · Feb 19, 2024 · 9c61377 · 9c61377
1 parent 5388042
commit 9c61377
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 7 deletions.
diff --git a/eodag/plugins/apis/base.py b/eodag/plugins/apis/base.py
@@ -98,7 +98,14 @@ def discover_product_types(self) -> Optional[Dict[str, Any]]:
     def discover_queryables(
         self, **kwargs: Any
     ) -> Optional[Dict[str, Annotated[Any, FieldInfo]]]:
-        """Fetch queryables list from provider using `discover_queryables` conf"""
+        """Fetch queryables list from provider using `discover_queryables` conf
+
+        :param kwargs: additional filters for queryables (`productType` and other search
+                       arguments)
+        :type kwargs: Any
+        :returns: fetched queryable parameters dict
+        :rtype: Optional[Dict[str, Annotated[Any, FieldInfo]]]
+        """
         return None
 
     def download(

diff --git a/eodag/plugins/apis/cds.py b/eodag/plugins/apis/cds.py
@@ -447,11 +447,11 @@ def discover_queryables(
     ) -> Optional[Dict[str, Annotated[Any, FieldInfo]]]:
         """Fetch queryables list from provider using `discover_queryables` conf
 
-        :param kwargs: additional filters for queryables (`productType` or other search
+        :param kwargs: additional filters for queryables (`productType` and other search
                        arguments)
         :type kwargs: Any
         :returns: fetched queryable parameters dict
-        :rtype: Optional[Dict[str, Tuple[Annotated[Any, FieldInfo], Any]]]
+        :rtype: Optional[Dict[str, Annotated[Any, FieldInfo]]]
         """
         constraints_file_url = getattr(self.config, "constraints_file_url", "")
         if not constraints_file_url:

diff --git a/eodag/plugins/search/base.py b/eodag/plugins/search/base.py
@@ -94,10 +94,12 @@ def discover_queryables(
         self, **kwargs: Any
     ) -> Optional[Dict[str, Annotated[Any, FieldInfo]]]:
         """Fetch queryables list from provider using `discover_queryables` conf
-        :param kwargs: additional filters for queryables (`productType` or other search arguments)
+
+        :param kwargs: additional filters for queryables (`productType` and other search
+                       arguments)
         :type kwargs: Any
         :returns: fetched queryable parameters dict
-        :rtype: Optional[Dict[str, Tuple[Annotated[Any, FieldInfo], Any]]]
+        :rtype: Optional[Dict[str, Annotated[Any, FieldInfo]]]
         """
         return None
 

diff --git a/eodag/plugins/search/qssearch.py b/eodag/plugins/search/qssearch.py
@@ -1286,11 +1286,11 @@ def discover_queryables(
     ) -> Optional[Dict[str, Annotated[Any, FieldInfo]]]:
         """Fetch queryables list from provider using `discover_queryables` conf
 
-        :param kwargs: additional filters for queryables (`productType` or other search
+        :param kwargs: additional filters for queryables (`productType` and other search
                        arguments)
         :type kwargs: Any
         :returns: fetched queryable parameters dict
-        :rtype: Optional[Dict[str, Tuple[Annotated[Any, FieldInfo], Any]]]
+        :rtype: Optional[Dict[str, Annotated[Any, FieldInfo]]]
         """
         product_type = kwargs.get("productType", None)
         provider_product_type = (