DOC: Add more Bento helper method docs

Author: cjdsellers

databento/common/bento.py

@@ -576,7 +576,7 @@ def to_json(self, path: str) -> None:
         """
         self.to_df().to_json(path, orient="records", lines=True)
 
-    def request_symbology(self, client) -> Dict[str, Dict[str, Any]]:
+    def request_symbology(self, client) -> Dict[str, Any]:
         """
         Request symbology resolution based on the metadata properties.
 
@@ -592,8 +592,9 @@ def request_symbology(self, client) -> Dict[str, Dict[str, Any]]:
 
         Returns
         -------
-        Dict[str, Dict[str, Any]]
-            A map of input symbol to output symbol across the date range.
+        Dict[str, Any]
+            A result including a map of input symbol to output symbol across a
+            date range.
 
         """
         return client.symbology.resolve(
@@ -618,9 +619,9 @@ def request_full_definitions(
         Parameters
         ----------
         client : Historical
-            The historical client to use for the request.
+            The historical client to use for the request (contains the API key).
         path : str, optional
-            The file path to write to on disk (if provided).
+            The path to stream the data to on disk (will then return a `FileBento`).
 
         Returns
         -------

databento/historical/api/symbology.py

@@ -1,5 +1,5 @@
 from datetime import date
-from typing import List, Optional, Tuple, Union
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 import pandas as pd
 from databento.common.enums import SType
@@ -27,7 +27,7 @@ def resolve(
         start_date: Union[date, str],
         end_date: Union[date, str],
         default_value: Optional[str] = "",
-    ):
+    ) -> Dict[str, Any]:
         """
         Request symbology mappings resolution from Databento.
 
@@ -53,8 +53,9 @@ def resolve(
 
         Returns
         -------
-        Dict[str, Dict[str, Any]]
-            A map of input symbol to output symbol across the date range.
+        Dict[str, Any]
+            A result including a map of input symbol to output symbol across a
+            date range.
 
         """
         dataset = enum_or_str_lowercase(dataset, "dataset")

databento/historical/api/timeseries.py

@@ -59,7 +59,7 @@ def stream(
         limit : int, optional
             The maximum number of records to return. If ``None`` then no limit.
         path : str, optional
-            The file path to write to on disk (if provided).
+            The path to stream the data to on disk (will then return a `FileBento`).
 
         Returns
         -------
@@ -155,7 +155,7 @@ async def stream_async(
         limit : int, optional
             The maximum number of records to return. If ``None`` then no limit.
         path : str, optional
-            The file path to write to on disk (if provided).
+            The path to stream the data to on disk (will then return a `FileBento`).
 
         Returns
         -------