Skip to content

Commit 50a58b3

Browse files
committed
docs: update Compression enum methods to include return type descriptions
1 parent 811f633 commit 50a58b3

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

python/datafusion/dataframe.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ def from_str(cls, value: str) -> "Compression":
6868
Args:
6969
value: The string representation of the compression type.
7070
71+
Returns:
72+
The Compression enum lowercase value.
73+
7174
Raises:
7275
ValueError: If the string does not match any Compression enum value.
7376
"""
@@ -79,7 +82,11 @@ def from_str(cls, value: str) -> "Compression":
7982
)
8083

8184
def get_default_level(self) -> Optional[int]:
82-
"""Get the default compression level for the compression type."""
85+
"""Get the default compression level for the compression type.
86+
87+
Returns:
88+
The default compression level for the compression type.
89+
"""
8390
# GZIP, BROTLI default values from deltalake repo
8491
# https://github.com/apache/datafusion-python/pull/981#discussion_r1905619163
8592
# ZSTD default value from delta-rs

0 commit comments

Comments
 (0)