Skip to content

Commit d0c322b

Browse files
committed
DOC: Standardize terminology
1 parent 4daf54e commit d0c322b

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

databento/common/bento.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,7 @@ def encoding(self) -> Encoding:
341341
@property
342342
def compression(self) -> Compression:
343343
"""
344-
Return the data compression mode.
344+
Return the data compression format (if any).
345345
346346
Returns
347347
-------

databento/common/enums.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class Encoding(Enum):
6565

6666
@unique
6767
class Compression(Enum):
68-
"""Represents a data compression mode."""
68+
"""Represents a data compression format (if any)."""
6969

7070
NONE = "none"
7171
ZSTD = "zstd"

databento/historical/api/batch.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def submit_job(
7373
encoding : Encoding or str {'dbz', 'csv', 'json'}, default 'dbz'
7474
The data encoding.
7575
compression : Compression or str {'none', 'zstd'}, optional
76-
The data compression mode.
76+
The data compression format (if any).
7777
If encoding is 'dbz' then specifying a `compression` is invalid (already zstd compressed).
7878
split_duration : Duration or str {'day', 'week', 'month', 'none'}, default 'day'
7979
The maximum time duration before batched data is split into multiple files.

0 commit comments

Comments
 (0)