DOC: Standardize dataset code description

Author: cjdsellers

databento/common/enums.py

@@ -30,7 +30,7 @@ class FeedMode(Enum):
 
 @unique
 class Dataset(Enum):
-    """Represents a dataset name (string identifier)."""
+    """Represents a dataset code (string identifier)."""
 
     GLBX_MDP3 = "GLBX.MDP3"
     XNAS_ITCH = "XNAS.ITCH"

databento/historical/api/batch.py

@@ -55,7 +55,7 @@ def timeseries_submit(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code (string identifier) for the request.
         symbols : List[Union[str, int]] or str, optional
             The product symbols to filter for. Takes up to 10,000 symbols per request.
             If more than 1 symbol is specified, the data is merged and sorted by time.

databento/historical/api/metadata.py

@@ -98,7 +98,7 @@ def list_schemas(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code (string identifier) for the request.
         start_date : date or str, optional
             The start date (UTC) for the request range.
         end_date : date or str, optional
@@ -143,7 +143,7 @@ def list_fields(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code (string identifier) for the request.
         schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, optional  # noqa
             The data record schema for the request.
         encoding : Encoding or str {'dbz', 'csv', 'json'}, optional
@@ -223,7 +223,7 @@ def list_unit_prices(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code for the request.
         mode : FeedMode or str {'live', 'historical-streaming', 'historical'}, optional
             The data feed mode for the request.
         schema : Schema or str {'mbo', 'mbp-1', 'mbp-10', 'trades', 'tbbo', 'ohlcv-1s', 'ohlcv-1m', 'ohlcv-1h', 'ohlcv-1d', 'definition', 'statistics', 'status'}, optional  # noqa
@@ -275,7 +275,7 @@ def get_shape(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code for the request.
         symbols : List[Union[str, int]] or str, optional
             The product symbols to filter for. Takes up to 10,000 symbols per request.
             If `*` or ``None`` then will be for **all** symbols.
@@ -352,7 +352,7 @@ def get_billable_size(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code for the request.
         symbols : List[Union[str, int]] or str, optional
             The product symbols to filter for. Takes up to 10,000 symbols per request.
             If `*` or ``None`` then will be for **all** symbols.
@@ -419,7 +419,7 @@ def get_cost(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code for the request.
         mode : FeedMode or str {'live', 'historical-streaming', 'historical'}, default 'historical-streaming'
             The data feed mode for the request.
         symbols : List[Union[str, int]] or str, optional

databento/historical/api/symbology.py

@@ -36,7 +36,7 @@ def resolve(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code (string identifier) for the request.
         symbols : List[Union[str, int]] or str, optional
             The symbols to resolve. Takes up to 10,000 symbols per request.
             If `*` or ``None`` then will be for **all** symbols.

databento/historical/api/timeseries.py

@@ -39,7 +39,7 @@ def stream(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code (string identifier) for the request.
         symbols : List[Union[str, int]] or str, optional
             The product symbols to filter for. Takes up to 10,000 symbols per request.
             If more than 1 symbol is specified, the data is merged and sorted by time.
@@ -136,7 +136,7 @@ async def stream_async(
         Parameters
         ----------
         dataset : Dataset or str
-            The dataset name for the request.
+            The dataset code (string identifier) for the request.
         symbols : List[Union[str, int]] or str, optional
             The product symbols to filter for. Takes up to 10,000 symbols per request.
             If more than 1 symbol is specified, the data is merged and sorted by time.