docs: add docstring to static function #260

ral-facilities · Dec 21, 2021 · 618f6b9 · 618f6b9
1 parent cf70161
commit 618f6b9
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/datagateway_api/src/search_api/nested_where_filters.py b/datagateway_api/src/search_api/nested_where_filters.py
@@ -48,7 +48,14 @@ def apply_filter(self, query):
     @staticmethod
     def set_search_api_query(query_filter, search_api_query):
         """
-        TODO
+        Using recursion, set the search API query to each of the WHERE filters contained
+        within the top-level `NestedWhereFilters` object
+
+        :param query_filter: Search API where filter or an instance of this class
+        :type query_filter: :class:`NestedWhereFilters` or an object inherited from
+            :class:`QueryFilter`
+        :param search_api_query: Search API query object
+        :type search_api_query: :class:`SearchAPIQuery`
         """
 
         log.debug(