chore(docs): small improvements

differt/src/differt/rt/utils.py

@@ -28,7 +28,7 @@
 # ruff: noqa: ERA001
 
 import sys
-from collections.abc import Callable, Iterator
+from collections.abc import Callable, Iterator, Sized
 from typing import Any, Generic, TypeVar
 
 import equinox as eqx
@@ -48,9 +48,13 @@
 T = TypeVar("T")
 
 @typechecker
-class SizedIterator(Iterator, Generic[T]):
+class SizedIterator(Iterator, Sized, Generic[T]):
     """A custom generatic class that is both :class:`Iterator<collections.abc.Iterator>` and :class:`Sized<collections.abc.Sized>`.
 
+    The main purpose of this class is to be able to use
+    `tqdm <https://github.com/tqdm/tqdm>`_ utilities
+    on iterators and have some meaningful information about how iterations are left.
+
     Args:
         iter_: The iterator.
         size: The size, i.e., length, of the iterator, or a callable that returns its current length.

docs/source/notebooks/type_checking.ipynb

@@ -136,7 +136,8 @@
     "The error message is a bit verbose,\n",
     "but we can see at the end that we expected `Shaped[Array, 'm n']`\n",
     "and we received `i32[2,10,4]` (i.e., `Int32[Array, \"2 10 4\"]`).\n",
-    "`Int32` is a subclass of `Shaped`, but `m n` cannot be matched to `2 10 4`, as there is\n",
+    "{class}`Int32<jaxtyping.Int32>` is a subclass of {class}`Shaped<jaxtyping.Shaped>`, \n",
+    "but `m n` cannot be matched to `2 10 4`, as there is\n",
     "one extra dimension. Thus, an error was raised for that reason."
    ]
   },