#144: Add documentation and style changes

ral-facilities · Sep 14, 2020 · 9a1b060 · 9a1b060
1 parent d3b08e4
commit 9a1b060
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/common/database/filters.py b/common/database/filters.py
@@ -14,6 +14,7 @@
 
 log = logging.getLogger()
 
+
 class DatabaseWhereFilter(WhereFilter):
     def __init__(self, field, value, operation):
         super().__init__(field, value, operation)
@@ -24,7 +25,10 @@ def __init__(self, field, value, operation):
 
     def _extract_filter_fields(self, field):
         """
-        TODO - Add docstring
+        Extract the related fields names and put them into separate variables
+
+        :param field: ICAT field names, separated by dots
+        :type field: :class:`str`
         """
 
         fields = field.split(".")
@@ -44,7 +48,6 @@ def _extract_filter_fields(self, field):
         else:
             raise ValueError(f"Maximum include depth exceeded. {field}'s depth > 3")
 
-
     def apply_filter(self, query):
         try:
             field = getattr(query.table, self.field)

diff --git a/common/filters.py b/common/filters.py
@@ -21,7 +21,7 @@ class WhereFilter(QueryFilter):
     precedence = 1
 
     def __init__(self, field, value, operation):
-        # The field is set to None as a precaution but this should be set by the 
+        # The field is set to None as a precaution but this should be set by the
         # individual backend since backends deal with this data differently
         self.field = None
         self.value = value