docs

Author: flying-sheep

docs/conf.py

@@ -48,9 +48,11 @@
     numpy=("https://numpy.org/doc/stable/", None),
     python=("https://docs.python.org/3", None),
     scipy=("https://docs.scipy.org/doc/scipy/", None),
+    zarr=("https://zarr.readthedocs.io/en/stable/", None),
 )
 # Try overriding type paths
 qualname_overrides = autodoc_type_aliases = {
+    "np.bool_": ("py:data", "numpy.bool_"),
     "np.dtype": "numpy.dtype",
     "np.number": "numpy.number",
     "np.integer": "numpy.integer",
@@ -62,15 +64,16 @@
     "CupySparseMatrix": "cupyx.scipy.sparse.spmatrix",
     "DaskArray": "dask.array.Array",
     "H5Dataset": "h5py.Dataset",
+    "ZarrArray": "zarr.Array",
 }
 # If that doesn’t work, ignore them
 nitpick_ignore = {
-    ("py:class", "DT_co"),
     ("py:class", "fast_array_utils.types.T_co"),
     # sphinx bugs, should be covered by `autodoc_type_aliases` above
     ("py:class", "ArrayLike"),
     ("py:class", "DTypeLike"),
     ("py:class", "NDArray"),
+    ("py:class", "np.bool_"),
 }
 
 # Options for HTML output

pyproject.toml

@@ -91,6 +91,7 @@ lint.flake8-type-checking.strict = true
 lint.isort.known-first-party = [ "fast_array_utils" ]
 lint.isort.lines-after-imports = 2
 lint.isort.required-imports = [ "from __future__ import annotations" ]
+lint.pydocstyle.convention = "numpy"
 
 [tool.pytest.ini_options]
 addopts = [

src/fast_array_utils/stats/_is_constant.py

@@ -13,22 +13,26 @@
 
 if TYPE_CHECKING:
     from collections.abc import Callable
-    from typing import Any, Literal, TypeAlias, TypeVar
+    from typing import Any, Literal, TypeVar
 
     from numpy.typing import NDArray
 
-    _Array: TypeAlias = NDArray[Any] | CSBase | H5Dataset | ZarrArray | DaskArray
-
     C = TypeVar("C", bound=Callable[..., Any])
 
 
 @overload
-def is_constant(a: _Array, axis: None = None) -> bool: ...
+def is_constant(
+    a: NDArray[Any] | CSBase | H5Dataset | ZarrArray | DaskArray, axis: None = None
+) -> bool: ...
 @overload
-def is_constant(a: _Array, axis: Literal[0, 1]) -> NDArray[np.bool_]: ...
+def is_constant(
+    a: NDArray[Any] | CSBase | H5Dataset | ZarrArray | DaskArray, axis: Literal[0, 1]
+) -> NDArray[np.bool_]: ...
 
 
-def is_constant(a: _Array, axis: Literal[0, 1] | None = None) -> bool | NDArray[np.bool_]:
+def is_constant(
+    a: NDArray[Any] | CSBase | H5Dataset | ZarrArray | DaskArray, axis: Literal[0, 1] | None = None
+) -> bool | NDArray[np.bool_]:
     """Check whether values in array are constant.
 
     Params
@@ -38,12 +42,11 @@ def is_constant(a: _Array, axis: Literal[0, 1] | None = None) -> bool | NDArray[
     axis
         Axis to reduce over.
 
-
-    Returns:
+    Returns
     -------
     Boolean array, True values were constant.
 
-    Example:
+    Example
     -------
     >>> a = np.array([[0, 1], [0, 0]])
     >>> a
@@ -69,7 +72,9 @@ def is_constant(a: _Array, axis: Literal[0, 1] | None = None) -> bool | NDArray[
 
 
 @singledispatch
-def _is_constant(a: _Array, axis: Literal[0, 1] | None = None) -> bool | NDArray[np.bool_]:
+def _is_constant(
+    a: NDArray[Any] | CSBase | H5Dataset | ZarrArray | DaskArray, axis: Literal[0, 1] | None = None
+) -> bool | NDArray[np.bool_]:
     raise NotImplementedError