Skip to content

Commit deb1db2

Browse files
authored
Merge pull request #207 from MarketSquare/improve-query-docs
Improve query docs
2 parents 6780772 + 29197dd commit deb1db2

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

src/DatabaseLibrary/query.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,12 @@ def query(
3434
parameters: Optional[List] = None,
3535
):
3636
"""
37-
Uses the input ``selectStatement`` to query for the values that will be returned as a list of tuples.
38-
Set optional input ``returnAsDict`` to True to return values as a list of dictionaries.
37+
Runs a query with the ``selectStatement`` and returns the result as a list of rows.
38+
The type of row values depends on the database module -
39+
usually they are tuples or tuple-like objects.
40+
41+
Set optional input ``returnAsDict`` to _True_ to explicitely convert the return values
42+
into a list of dictionaries.
3943
4044
Use optional ``alias`` parameter to specify what connection should be used for the query if you have more
4145
than one connection open.

src/DatabaseLibrary/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
VERSION = "1.4.1"
1+
VERSION = "1.4.2"

0 commit comments

Comments
 (0)