fixes

Signed-off-by: Robert Kruszewski <github@robertk.io>

Author: robert3005

docs/api/python/arrays.rst

@@ -128,7 +128,7 @@ Pluggable Encodings
 -------------------
 
 Subclasses of :class:`~vortex.PyArray` can be used to implement custom Vortex encodings in Python. These encodings
-can be registered with the :attr:`~vortex.registry` so they are available to use when reading Vortex files.
+can be registered with :func:`vortex.registry.register` so they are available to use when reading Vortex files.
 
 .. autoclass:: vortex.PyArray
     :members:

docs/api/python/expr.rst

@@ -51,10 +51,12 @@ the following expression represents the set of rows for which the `age` column l
       >>> import vortex as vx
       >>> import vortex.expr as ve
       >>> import pyarrow as pa
+      >>>
       >>> array = pa.array([
       ...     {"x": 1, "y": {"yy": "a"}},
       ...     {"x": 2, "y": {"yy": "b"}},
       ... ])
+      >>>
       >>> vx.io.write(vx.array(array), '/tmp/foo.vortex')
       >>> (vx.file.open('/tmp/foo.vortex')
       ...    .scan(expr=vx.expr.column("y")["yy"] == "a")

docs/api/python/registry.rst

@@ -4,4 +4,5 @@ Registry
 The Python registry module registers Python extension types with the process-wide Vortex registry.
 
 .. automodule:: vortex.registry
-   :members:
+
+.. autofunction:: vortex.registry.register

docs/getting-started/python.rst

@@ -36,6 +36,7 @@ Use :func:`~vortex.io.write` to write the Vortex array to disk:
 .. doctest::
 
    >>> import vortex as vx
+   >>>
    >>> vx.io.write(vtx, "example.vortex")  # doctest: +SKIP
 
 Small Vortex files (this one is just 71KiB) currently have substantial overhead relative to their
@@ -56,6 +57,7 @@ Use :func:`~vortex.open` to open and read the Vortex array from disk:
 .. doctest::
 
    >>> import vortex as vx
+   >>>
    >>> cvtx = vx.open("example.vortex").scan().read_all()  # doctest: +SKIP
 
 
@@ -68,6 +70,7 @@ IO and decoding and read just the data that is relevant to you:
 .. doctest::
 
     >>> import vortex as vx
+    >>>
     >>> vf = vx.open("example.vortex")  # doctest: +SKIP
     >>> # row indices must be ordered and unique
     >>> indices = vx.array([1, 2, 10])

docs/user-guide/pandas.md

@@ -10,7 +10,9 @@ convert:
 ```{doctest} pycon
 >>> import vortex as vx
 >>> import pyarrow.parquet as pq
+>>>
 >>> vx.io.write(pq.read_table("_static/example.parquet"), 'example.vortex')
+>>>
 >>> f = vx.open('example.vortex')
 >>> df = f.scan().read_all().to_pandas()
 >>> df[['tip_amount', 'fare_amount']].head(3)
@@ -47,6 +49,7 @@ convert:
 
 ```{doctest} pycon
 >>> import pandas as pd
+>>>
 >>> df = pd.DataFrame({'age': [25, 31, 33, 57], 'name': ['Joseph', 'Narendra', 'Angela', 'Mikhail']})
 >>> vx.array(df).to_arrow_table()
 pyarrow.Table

docs/user-guide/polars.md

@@ -13,7 +13,9 @@ Vortex integrates with Polars via {meth}`.VortexFile.to_polars`, which returns a
 ```{doctest} pycon
 >>> import vortex as vx
 >>> import pyarrow.parquet as pq
+>>>
 >>> vx.io.write(pq.read_table("_static/example.parquet"), 'example.vortex')
+>>>
 >>> lf = vx.open('example.vortex').to_polars()
 >>> lf = lf.select('tip_amount', 'fare_amount')
 >>> lf = lf.head(3)

docs/user-guide/pyarrow.md

@@ -12,6 +12,7 @@ anything that implements `IntoArrayIterator`, including {class}`pyarrow.Table` a
 ```{doctest} pycon
 >>> import pyarrow.parquet as pq
 >>> import vortex as vx
+>>>
 >>> table = pq.read_table("_static/example.parquet")
 >>> vx.io.write(table, 'example.vortex')
 ```
@@ -65,6 +66,7 @@ The {func}`~vortex.array` function constructs a Vortex array from an Arrow array
 
 ```{doctest} pycon
 >>> import pyarrow as pa
+>>>
 >>> arrow = pa.array([1, 2, None, 3])
 >>> arr = vx.array(arrow)
 >>> arr.dtype

docs/user-guide/ray.md

@@ -9,8 +9,10 @@ and then run `make -C docs doctest` -->
 >>> import vortex as vx
 >>> import pyarrow.parquet as pq
 >>> import os
+>>>
 >>> os.makedirs("ray_data", exist_ok=True)
 >>> table = pq.read_table("_static/example.parquet")
+>>>
 >>> vx.io.write(table, 'ray_data/example-01.vortex')
 >>> vx.io.write(table, 'ray_data/example-02.vortex')
 >>> vx.io.write(table, 'ray_data/example-03.vortex')

docs/user-guide/vortex-python.md

@@ -123,6 +123,7 @@ applied directly:
 
 ```{doctest} pycon
 >>> import vortex.expr as ve
+>>>
 >>> arr = vx.array([
 ...     {'name': 'Alice', 'age': 30},
 ...     {'name': 'Bob', 'age': 25},
@@ -139,7 +140,9 @@ applied directly:
 
 ```{doctest} pycon
 >>> import pyarrow.parquet as pq
+>>>
 >>> vx.io.write(pq.read_table("_static/example.parquet"), 'example.vortex')
+>>>
 >>> f = vx.open('example.vortex')
 >>> len(f)
 1000