Apply suggestions from code review

Co-authored-by: Joren Hammudoglu <[email protected]>
Co-authored-by: Lucas Colley <[email protected]>
Signed-off-by: Nathaniel Starkman <[email protected]>

Author: 3 people

README.md

@@ -1,5 +1,5 @@
-<h1 align='center'> array-api-typing </h1>
-<h3 align="center">Type Annotations for the Array APi</h3>
+<h1 align="center"> array-api-typing </h1>
+<h3 align="center">Type Annotations for the Python array API standard</h3>
 
 ---
 
@@ -21,7 +21,7 @@ uv add array-api-typing
   <summary>from source, using pip</summary>
 
 ```bash
-pip install git+https://https://github.com/data-apis/array-api-typing.git
+pip install git+https://github.com/data-apis/array-api-typing.git
 ```
 
 </details>
@@ -30,7 +30,7 @@ pip install git+https://https://github.com/data-apis/array-api-typing.git
 
 ```bash
 cd /path/to/parent
-git clone https://https://github.com/data-apis/array-api-typing.git
+git clone https://github.com/data-apis/array-api-typing.git
 cd array-api-typing
 pip install -e .  # editable mode
 ```
@@ -43,7 +43,7 @@ pip install -e .  # editable mode
 >>> import array_api_typing as xpt
 >>> import numpy as np
 
->>> def func(x: xpt.HasNamespace) -> xpt.HasNamespace:
+>>> def func(x: xpt.HasArrayNamespace) -> xpt.HasArrayNamespace:
 ...    return x
 
 >>> func(np.array([1, 2, 3]))

conftest.py

@@ -11,4 +11,4 @@
     pattern="src/**/*.py",
 )
 
-pytest_collect_file = (readme_tester + python_file_tester).pytest()
+pytest_collect_file = (readme_tester + python_file_tester).pytest()

pyproject.toml

@@ -50,7 +50,7 @@
     "pytest-cov>=3",
     "pytest-github-actions-annotate-failures>=0.3.0",
     "sybil>=8.0.0",
-]
+  ]
 
 
 [tool.hatch]

src/array_api_typing/__init__.py

@@ -1,6 +1,6 @@
 """Static typing support for the array API standard."""
 
-__all__ = ["HasNamespace"]
+__all__ = ["HasArrayNamespace", "__version__", "__version_tuple__"]
 
-from ._version import version as __version__ , version_tuple as __version_tuple__
-from ._namespace import HasNamespace
+from ._namespace import HasArrayNamespace
+from ._version import version as __version__, version_tuple as __version_tuple__

src/array_api_typing/_namespace.py

@@ -1,6 +1,6 @@
 """Static typing support for the array API standard."""
 
-__all__ = ["HasNamespace"]
+__all__ = ["HasArrayNamespace"]
 
 from types import ModuleType
 from typing import Protocol, final
@@ -10,11 +10,9 @@
 
 
 @final
-class HasNamespace(Protocol[T]):  # type: ignore[misc]  # see python/mypy#17288
+class HasArrayNamespace(Protocol[T]):  # type: ignore[misc]  # see python/mypy#17288
     """Protocol for classes that have an `__array_namespace__` method.
 
-    This is for type-annotating objects that should
-
     Example:
     >>> import array_api_typing as xpt
     >>>
@@ -23,9 +21,9 @@ class HasNamespace(Protocol[T]):  # type: ignore[misc]  # see python/mypy#17288
     ...         return object()
     >>>
     >>> x = MyArray()
-    >>> def has_namespace(x: xpt.HasNamespace) -> bool:
+    >>> def has_array_namespace(x: xpt.HasArrayNamespace) -> bool:
     ...     return hasattr(x, "__array_namespace__")
-    >>> has_namespace(x)
+    >>> has_array_namespace(x)
     True
 
     """