Update documentation (#663)

README.md

@@ -114,7 +114,7 @@ False
 
 ```
 
-The current supported types are:
+`coola` supports the following types:
 
 - [`jax.numpy.ndarray`](https://jax.readthedocs.io/en/latest/index.html)
 - [`numpy.ndarray`](https://numpy.org/doc/stable/index.html)

docs/docs/types.md

@@ -18,6 +18,11 @@ The current supported types are:
 - [`xarray.Dataset`](https://docs.xarray.dev/en/stable/)
 - [`xarray.Variable`](https://docs.xarray.dev/en/stable/)
 
+`coola` also provides experimental/partial support for the following types:
+
+- [`pyarrow.Array`](https://arrow.apache.org/docs/python/generated/pyarrow.Array.html) (`equal_nan`, `atol` and `rtol` arguments are ignored)
+- [`pyarrow.Table`](https://arrow.apache.org/docs/python/generated/pyarrow.Table.html) (`equal_nan`, `atol` and `rtol` arguments are ignored)
+
 ## Equal
 
 ### `object`

src/coola/equality/comparators/pyarrow_.py

@@ -32,6 +32,9 @@ class PyarrowEqualityComparator(BaseEqualityComparator[pa.Array]):
     r"""Implement an equality comparator for ```pyarrow.Array``s and
     ``pyarrow.Table``s.
 
+    Note that ``config.equal_nan``, ``config.atol`` and ``config.rtol``
+    arguments are ignored.
+
     Example usage:
 
     ```pycon

src/coola/equality/handlers/pyarrow_.py

@@ -32,6 +32,9 @@ class PyarrowEqualHandler(BaseEqualityHandler):
     the end of the chain of responsibility. This handler does
     not call the next handler.
 
+    Note that ``config.equal_nan``, ``config.atol`` and ``config.rtol``
+    arguments are ignored.
+
     Example usage:
 
     ```pycon
@@ -77,6 +80,9 @@ def object_equal(
     r"""Indicate if the two arrays or tables are equal within a
     tolerance.
 
+    ``config.equal_nan``, ``config.atol`` and ``config.rtol``
+    arguments are ignored.
+
     Args:
         obj1: The first array or table to compare.
         obj2: The second array or table to compare.