From 729d3e5cf3c3524753893b99323a00fc5d66d6a9 Mon Sep 17 00:00:00 2001 From: Ethan Dalool Date: Wed, 10 Nov 2021 23:02:22 -0800 Subject: [PATCH] Improve bytestring docstring. --- voussoirkit/bytestring.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/voussoirkit/bytestring.py b/voussoirkit/bytestring.py index 634be02..05e69fa 100644 --- a/voussoirkit/bytestring.py +++ b/voussoirkit/bytestring.py @@ -80,10 +80,13 @@ def bytestring(size, decimal_places=3, force_unit=None): '762.939 MiB' >>> bytestring(800000000, decimal_places=0) '763 MiB' + decimal_places: + The number of digits after the decimal, including trailing zeros, + for all divisors except bytes. force_unit: + You can provide one of the size constants to force that divisor. If None, an appropriate size unit is chosen automatically. - Otherwise, you can provide one of the size constants to force that divisor. ''' if force_unit is None: divisor = get_appropriate_divisor(size)