#34: Add Missing docstring

ral-facilities · Aug 22, 2019 · 455bfdd · 455bfdd
1 parent ccfb01e
commit 455bfdd
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/common/database_helpers.py b/common/database_helpers.py
@@ -416,7 +416,13 @@ def get_single_result(self):
 
 
 def get_investigations_for_user(user_id, filters):
-    query = ISISInvestigationsQuery(user_id) 
+    """
+    Given a user id and a list of filters, return a filtered list of all investigations that belong to that user
+    :param user_id: The id of the user
+    :param filters: The list of filters
+    :return: A list of dictionary representations of the investigation entities
+    """
+    query = ISISInvestigationsQuery(user_id)
     filter_handler = FilterOrderHandler()
     try:
         for query_filter in filters: