Merge pull request numpy#30183 from star1327p/grammar-issues

mattip · web-flow · commit 84016ed504ce · 2025-11-10T09:07:05.000+02:00
DOC: Corrected grammatical issues in code comments
diff --git a/doc/source/dev/depending_on_numpy.rst b/doc/source/dev/depending_on_numpy.rst
@@ -92,7 +92,7 @@ If a package either uses the NumPy C-API directly or it uses some other tool
 that depends on it like Cython or Pythran, NumPy is a *build-time* dependency
 of the package.
 
-By default, NumPy exposes a API that is backward compatible with the earliest
+By default, NumPy exposes an API that is backward compatible with the earliest
 NumPy version that supports the oldest Python version currently supported by
 NumPy. For example, NumPy 1.25.0 supports Python 3.9 and above; and the
 earliest NumPy version to support Python 3.9 was 1.19. Therefore we guarantee
diff --git a/numpy/_core/src/multiarray/array_converter.c b/numpy/_core/src/multiarray/array_converter.c
@@ -97,7 +97,7 @@ array_converter_new(
         Py_INCREF(item->DType);
 
         /*
-         * Check whether we were passed a an int/float/complex Python scalar.
+         * Check whether we were passed an int/float/complex Python scalar.
          * If not, set `descr` and clear pyscalar/scalar flags as needed.
          */
         if (item->scalar_input && npy_mark_tmp_array_if_pyscalar(
diff --git a/numpy/_core/src/multiarray/array_method.h b/numpy/_core/src/multiarray/array_method.h
@@ -69,7 +69,7 @@ typedef struct PyArrayMethodObject_tag {
 
 
 /*
- * We will sometimes have to create a ArrayMethod and allow passing it around,
+ * We will sometimes have to create an ArrayMethod and allow passing it around,
  * similar to `instance.method` returning a bound method, e.g. a function like
  * `ufunc.resolve()` can return a bound object.
  * The current main purpose of the BoundArrayMethod is that it holds on to the
diff --git a/numpy/_core/src/multiarray/compiled_base.c b/numpy/_core/src/multiarray/compiled_base.c
@@ -450,7 +450,7 @@ _linear_search(const npy_double key, const npy_double *arr, const npy_intp len,
 
 /** @brief find index of a sorted array such that arr[i] <= key < arr[i + 1].
  *
- * If an starting index guess is in-range, the array values around this
+ * If a starting index guess is in-range, the array values around this
  * index are first checked.  This allows for repeated calls for well-ordered
  * keys (a very common case) to use the previous index as a very good guess.
  *
diff --git a/numpy/_core/src/multiarray/nditer_pywrap.c b/numpy/_core/src/multiarray/nditer_pywrap.c
@@ -916,7 +916,7 @@ NpyIter_NestedIters(PyObject *NPY_UNUSED(self),
         }
         if (!PyTuple_Check(item) && !PyList_Check(item)) {
             PyErr_SetString(PyExc_ValueError,
-                    "Each item in axes must be a an integer tuple");
+                    "Each item in axes must be an integer tuple");
             Py_DECREF(item);
             return NULL;
         }
diff --git a/numpy/_core/src/multiarray/textreading/rows.c b/numpy/_core/src/multiarray/textreading/rows.c
@@ -156,7 +156,7 @@ create_conv_funcs(
  *        returned array can differ for strings.
  * @param homogeneous Whether the datatype of the array is not homogeneous,
  *        i.e. not structured.  In this case the number of columns has to be
- *        discovered an the returned array will be 2-dimensional rather than
+ *        discovered and the returned array will be 2-dimensional rather than
  *        1-dimensional.
  *
  * @returns Returns the result as an array object or NULL on error.  The result
diff --git a/numpy/_core/tests/test_dtype.py b/numpy/_core/tests/test_dtype.py
@@ -209,7 +209,7 @@ def test_field_order_equality(self):
                       'formats': ['i4', 'f4'],
                       'offsets': [4, 0]})
         assert_equal(x == y, False)
-        # This is an safe cast (not equiv) due to the different names:
+        # This is a safe cast (not equiv) due to the different names:
         assert np.can_cast(x, y, casting="safe")
 
     @pytest.mark.parametrize(
diff --git a/numpy/distutils/pathccompiler.py b/numpy/distutils/pathccompiler.py
@@ -3,7 +3,7 @@
 class PathScaleCCompiler(UnixCCompiler):
 
     """
-    PathScale compiler compatible with an gcc built Python.
+    PathScale compiler compatible with a gcc built Python.
     """
 
     compiler_type = 'pathcc'
diff --git a/numpy/lib/_function_base_impl.py b/numpy/lib/_function_base_impl.py
@@ -4731,7 +4731,7 @@ def _quantile(
     if weights is None:
         # --- Computation of indexes
         # Index where to find the value in the sorted array.
-        # Virtual because it is a floating point value, not an valid index.
+        # Virtual because it is a floating point value, not a valid index.
         # The nearest neighbours are used for interpolation
         try:
             method_props = _QuantileMethods[method]
diff --git a/numpy/lib/mixins.py b/numpy/lib/mixins.py
@@ -70,7 +70,7 @@ class NDArrayOperatorsMixin:
     but that should support arithmetic and numpy universal functions like
     arrays as described in :external+neps:doc:`nep-0013-ufunc-overrides`.
 
-    As an trivial example, consider this implementation of an ``ArrayLike``
+    As a trivial example, consider this implementation of an ``ArrayLike``
     class that simply wraps a NumPy array and ensures that the result of any
     arithmetic operation is also an ``ArrayLike`` object:
 
diff --git a/numpy/lib/tests/test_histograms.py b/numpy/lib/tests/test_histograms.py
@@ -136,7 +136,7 @@ def test_bool_conversion(self):
         a = np.array([1, 1, 0], dtype=np.uint8)
         int_hist, int_edges = np.histogram(a)
 
-        # Should raise an warning on booleans
+        # Should raise a warning on booleans
         # Ensure that the histograms are equivalent, need to suppress
         # the warnings to get the actual outputs
         with pytest.warns(RuntimeWarning, match='Converting input from .*'):
diff --git a/numpy/polynomial/hermite.py b/numpy/polynomial/hermite.py
@@ -796,7 +796,7 @@ def hermint(c, m=1, k=[], lbnd=0, scl=1, axis=0):
 
 def hermval(x, c, tensor=True):
     """
-    Evaluate an Hermite series at points x.
+    Evaluate a Hermite series at points x.
 
     If `c` is of length ``n + 1``, this function returns the value:
 
@@ -1439,7 +1439,7 @@ def hermcompanion(c):
     """Return the scaled companion matrix of c.
 
     The basis polynomials are scaled so that the companion matrix is
-    symmetric when `c` is an Hermite basis polynomial. This provides
+    symmetric when `c` is a Hermite basis polynomial. This provides
     better eigenvalue estimates than the unscaled case and for basis
     polynomials the eigenvalues are guaranteed to be real if
     `numpy.linalg.eigvalsh` is used to obtain them.
@@ -1693,7 +1693,7 @@ def hermweight(x):
 #
 
 class Hermite(ABCPolyBase):
-    """An Hermite series class.
+    """A Hermite series class.
 
     The Hermite class provides the standard Python numerical methods
     '+', '-', '*', '//', '%', 'divmod', '**', and '()' as well as the
diff --git a/numpy/polynomial/hermite_e.py b/numpy/polynomial/hermite_e.py
@@ -794,7 +794,7 @@ def hermeint(c, m=1, k=[], lbnd=0, scl=1, axis=0):
 
 def hermeval(x, c, tensor=True):
     """
-    Evaluate an HermiteE series at points x.
+    Evaluate a HermiteE series at points x.
 
     If `c` is of length ``n + 1``, this function returns the value:
 
@@ -1365,7 +1365,7 @@ def hermecompanion(c):
     Return the scaled companion matrix of c.
 
     The basis polynomials are scaled so that the companion matrix is
-    symmetric when `c` is an HermiteE basis polynomial. This provides
+    symmetric when `c` is a HermiteE basis polynomial. This provides
     better eigenvalue estimates than the unscaled case and for basis
     polynomials the eigenvalues are guaranteed to be real if
     `numpy.linalg.eigvalsh` is used to obtain them.
@@ -1595,7 +1595,7 @@ def hermeweight(x):
 #
 
 class HermiteE(ABCPolyBase):
-    """An HermiteE series class.
+    """A HermiteE series class.
 
     The HermiteE class provides the standard Python numerical methods
     '+', '-', '*', '//', '%', 'divmod', '**', and '()' as well as the
diff --git a/numpy/random/_pcg64.pyx b/numpy/random/_pcg64.pyx
@@ -264,7 +264,7 @@ cdef class PCG64(BitGenerator):
 
         * The random values are simulated using a rejection-based method
           and so, on average, more than one value from the underlying
-          RNG is required to generate an single draw.
+          RNG is required to generate a single draw.
         * The number of bits required to generate a simulated value
           differs from the number of bits generated by the underlying
           RNG.  For example, two 16-bit integer values can be simulated
@@ -498,7 +498,7 @@ cdef class PCG64DXSM(BitGenerator):
 
         * The random values are simulated using a rejection-based method
           and so, on average, more than one value from the underlying
-          RNG is required to generate an single draw.
+          RNG is required to generate a single draw.
         * The number of bits required to generate a simulated value
           differs from the number of bits generated by the underlying
           RNG.  For example, two 16-bit integer values can be simulated
diff --git a/numpy/random/_philox.pyx b/numpy/random/_philox.pyx
@@ -315,7 +315,7 @@ cdef class Philox(BitGenerator):
 
         * The random values are simulated using a rejection-based method
           and so, on average, more than one value from the underlying
-          RNG is required to generate an single draw.
+          RNG is required to generate a single draw.
         * The number of bits required to generate a simulated value
           differs from the number of bits generated by the underlying
           RNG.  For example, two 16-bit integer values can be simulated

Original file line number	Diff line number	Diff line change
`@@ -450,7 +450,7 @@ _linear_search(const npy_double key, const npy_double *arr, const npy_intp len,`
`450`	`450`
`451`	`451`	`/** @brief find index of a sorted array such that arr[i] <= key < arr[i + 1].`
`452`	`452`	`*`
`453`		`- * If an starting index guess is in-range, the array values around this`
	`453`	`+ * If a starting index guess is in-range, the array values around this`
`454`	`454`	`* index are first checked. This allows for repeated calls for well-ordered`
`455`	`455`	`* keys (a very common case) to use the previous index as a very good guess.`
`456`	`456`	`*`
Original file line number	Diff line number	Diff line change
`@@ -916,7 +916,7 @@ NpyIter_NestedIters(PyObject *NPY_UNUSED(self),`
`916`	`916`	`}`
`917`	`917`	`if (!PyTuple_Check(item) && !PyList_Check(item)) {`
`918`	`918`	`PyErr_SetString(PyExc_ValueError,`
`919`		`- "Each item in axes must be a an integer tuple");`
	`919`	`+ "Each item in axes must be an integer tuple");`
`920`	`920`	`Py_DECREF(item);`
`921`	`921`	`return NULL;`
`922`	`922`	`}`
Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ create_conv_funcs(`
`156`	`156`	`* returned array can differ for strings.`
`157`	`157`	`* @param homogeneous Whether the datatype of the array is not homogeneous,`
`158`	`158`	`* i.e. not structured. In this case the number of columns has to be`
`159`		`- * discovered an the returned array will be 2-dimensional rather than`
	`159`	`+ * discovered and the returned array will be 2-dimensional rather than`
`160`	`160`	`* 1-dimensional.`
`161`	`161`	`*`
`162`	`162`	`* @returns Returns the result as an array object or NULL on error. The result`