Merge pull request #207 from MarketSquare/improve-query-docs

Improve query docs
MarketSquare · Dec 19, 2023 · deb1db2 · deb1db2
2 parents 6780772 + 29197dd
commit deb1db2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/DatabaseLibrary/query.py b/src/DatabaseLibrary/query.py
@@ -34,8 +34,12 @@ def query(
         parameters: Optional[List] = None,
     ):
         """
-        Uses the input ``selectStatement`` to query for the values that will be returned as a list of tuples.
-        Set optional input ``returnAsDict`` to True to return values as a list of dictionaries.
+        Runs a query with the ``selectStatement`` and returns the result as a list of rows.
+        The type of row values depends on the database module -
+        usually they are tuples or tuple-like objects.
+
+        Set optional input ``returnAsDict`` to _True_ to explicitely convert the return values
+        into a list of dictionaries.
 
         Use optional ``alias`` parameter to specify what connection should be used for the query if you have more
         than one connection open.

diff --git a/src/DatabaseLibrary/version.py b/src/DatabaseLibrary/version.py
@@ -1 +1 @@
-VERSION = "1.4.1"
+VERSION = "1.4.2"