From c4b46fbabd46bef6b568f4ccdde720832b18978a Mon Sep 17 00:00:00 2001 From: Keiran Price Date: Wed, 30 Oct 2019 08:50:28 +0000 Subject: [PATCH] #87: Add Query Docstring --- common/database_helpers.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/common/database_helpers.py b/common/database_helpers.py index 320bf181..72cb99e1 100644 --- 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()