updated docs

caniko · Apr 11, 2022 · 54055e0 · 54055e0
1 parent 5275fc8
commit 54055e0
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/pydantic_numpy/__init__.py b/pydantic_numpy/__init__.py
@@ -26,6 +26,8 @@ def validate(cls, val: Any, field: ModelField) -> np.ndarray:
             return _validate(cls, val, field)
 
     class PotentialNDArray(Generic[T], np.ndarray):
+        """Like NDArray, but validation errors result in None."""
+
         @classmethod
         def __get_validators__(cls):
             yield cls.validate

diff --git a/tests/test_array.py → tests/test_ndarray.py b/tests/test_array.py → tests/test_ndarray.py