#87: Add Query Docstring

ral-facilities · Oct 30, 2019 · c4b46fb · c4b46fb
1 parent 0b45c2a
commit c4b46fb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/common/database_helpers.py b/common/database_helpers.py
@@ -15,6 +15,10 @@
 
 
 class Query(ABC):
+    """
+    The base query class that all other queries extend from. This defines the enter and exit methods, used to handle
+    sessions. It is expected that all queries would be used with the 'with' keyword in most cases for this reason.
+    """
     @abstractmethod
     def __init__(self, table):
         self.session = session_manager.get_icat_db_session()