Doctest for Codec

apache · Aug 23, 2022 · eed7303 · eed7303
1 parent 6b49d22
commit eed7303
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/python/pyarrow/io.pxi b/python/pyarrow/io.pxi
@@ -1859,6 +1859,17 @@ cdef class Codec(_Weakrefable):
     ------
     ValueError
         If invalid compression value is passed.
+
+    Examples
+    --------
+    >>> import pyarrow as pa
+    >>> pa.Codec.is_available('gzip')
+    True
+    >>> codec = pa.Codec('gzip')
+    >>> codec.name
+    'gzip'
+    >>> codec.compression_level
+    9
     """
 
     def __init__(self, str compression not None, compression_level=None):