Add documentation to query_by_comparing_versions

another-rex · Aug 27, 2024 · 4afea58 · 4afea58
1 parent 2719d3b
commit 4afea58
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/gcp/api/server.py b/gcp/api/server.py
@@ -1231,7 +1231,15 @@ def _query_by_comparing_versions(context: QueryContext, query: ndb.Query,
   """
   Query by comparing versions.
 
-  TODO:
+  Args:
+    context: QueryContext for the current query.
+    query: A partially completed ndb.Query object which only needs 
+      version filters to be added before query is performed.
+    ecosystem: Optional ecosystem of the package to query.
+    version: The version str to query by.
+
+  Returns:
+    list of osv.Bugs
   """
   bugs = []