Added docs for bit conversion

pydantic · Jan 8, 2024 · 23fd3f3 · 23fd3f3
1 parent 3feb7c5
commit 23fd3f3
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/pydantic/types.py b/pydantic/types.py
@@ -1834,11 +1834,13 @@ def human_readable(self, decimal: bool = False) -> str:
         return f'{num:0.1f}{final_unit}'
 
     def to(self, unit: str) -> float:
-        """Converts a byte size to another unit.
+        """Converts a byte size to another unit, including both byte and bit units.
 
         Args:
-            unit: The unit to convert to. Must be one of the following: B, KB, MB, GB, TB, PB, EiB,
-                KiB, MiB, GiB, TiB, PiB, EiB.
+            unit: The unit to convert to. Must be one of the following: B, KB, MB, GB, TB, PB, EB,
+                KiB, MiB, GiB, TiB, PiB, EiB (byte units) and
+                bit, kbit, mbit, gbit, tbit, pbit, ebit,
+                kibit, mibit, gibit, tibit, pibit, eibit (bit units).
 
         Returns:
             The byte size in the new unit.