Skip to content

Commit 29af533

Browse files
committed
Improve docstring on C/DParameter.bounds()
1 parent 741fe2a commit 29af533

1 file changed

Lines changed: 10 additions & 2 deletions

File tree

Lib/compression/zstd/__init__.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,11 @@ class CParameter(enum.IntEnum):
210210
overlap_log = _zstd._ZSTD_c_overlapLog
211211

212212
def bounds(self):
213-
"""Return lower and upper bounds of a compression parameter, both inclusive."""
213+
"""Returns a tuple of ints (lower, upper), representing the bounds of a
214+
compression parameter.
215+
216+
Both lower and upper bounds are inclusive.
217+
"""
214218
return _zstd._get_param_bounds(is_compress=True, parameter=self.value)
215219

216220

@@ -220,7 +224,11 @@ class DParameter(enum.IntEnum):
220224
window_log_max = _zstd._ZSTD_d_windowLogMax
221225

222226
def bounds(self):
223-
"""Return lower and upper bounds of a decompression parameter, both inclusive."""
227+
"""Returns a tuple of ints (lower, upper) representing the bounds of a
228+
decompression parameter.
229+
230+
Both lower and upper bounds are inclusive.
231+
"""
224232
return _zstd._get_param_bounds(is_compress=False, parameter=self.value)
225233

226234

0 commit comments

Comments
 (0)