the docstring for find_one was slightly misleading

datastax · Nov 23, 2023 · b0591a7 · b0591a7
1 parent 1740bf0
commit b0591a7
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/astrapy/db.py b/astrapy/db.py
@@ -517,7 +517,11 @@ def find_one(
             sort (dict, optional): Specifies the order in which to return the document.
             options (dict, optional): Additional options for the query.
         Returns:
-            dict: The found document or None if no matching document is found.
+            dict: the response, either
+                {"data": {"document": <DOCUMENT> }}
+            or
+                {"data": {"document": None}}
+            depending on whether a matching document is found or not.
         """
         json_query = make_payload(
             top_level="findOne",