DOC: Correct more ndarray defaults #29402

MarcoGorelli · 2025-07-21T12:43:33Z

Follow-up to https://github.com/numpy/numpy/pull/29387/files

These are the other methods which have a np._NoDefault default, and all the arguments just get forwarded to the corresponding top-level function

all:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2489 to 2494 in b5d6eb4

    
           static PyObject * 
        
           array_all(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_all); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 2587 to 2588 in 8cf1f7d

    
           @array_function_dispatch(_all_dispatcher) 
        
           def all(a, axis=None, out=None, keepdims=np._NoValue, *, where=np._NoValue):

any:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2481 to 2486 in b5d6eb4

    
           static PyObject * 
        
           array_any(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_any); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 2475 to 2476 in 8cf1f7d

    
           @array_function_dispatch(_any_dispatcher) 
        
           def any(a, axis=None, out=None, keepdims=np._NoValue, *, where=np._NoValue):

clip:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2584 to 2589 in b5d6eb4

    
           static PyObject * 
        
           array_clip(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_clip); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 2239 to 2241 in 8cf1f7d

    
           @array_function_dispatch(_clip_dispatcher) 
        
           def clip(a, a_min=np._NoValue, a_max=np._NoValue, out=None, *, 
        
                    min=np._NoValue, max=np._NoValue, **kwargs):

max:

numpy/numpy/_core/src/multiarray/methods.c

Lines 349 to 354 in b5d6eb4

    
           static PyObject * 
        
           array_max(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_amax); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 3050 to 3053 in 8cf1f7d

    
           @array_function_dispatch(_max_dispatcher) 
        
           @set_module('numpy') 
        
           def max(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue, 
        
                    where=np._NoValue):

min:

numpy/numpy/_core/src/multiarray/methods.c

Lines 356 to 361 in b5d6eb4

    
           static PyObject * 
        
           array_min(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_amin); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 3188 to 3190 in 8cf1f7d

    
           @array_function_dispatch(_min_dispatcher) 
        
           def min(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue, 
        
                   where=np._NoValue):

mean:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2384 to 2389 in b5d6eb4

    
           static PyObject * 
        
           array_mean(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_mean); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 3738 to 3740 in 8cf1f7d

    
           @array_function_dispatch(_mean_dispatcher) 
        
           def mean(a, axis=None, dtype=None, out=None, keepdims=np._NoValue, *, 
        
                    where=np._NoValue):

prod:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2421 to 2426 in b5d6eb4

    
           static PyObject * 
        
           array_prod(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_prod); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 3326 to 3328 in 8cf1f7d

    
           @array_function_dispatch(_prod_dispatcher) 
        
           def prod(a, axis=None, dtype=None, out=None, keepdims=np._NoValue, 
        
                    initial=np._NoValue, where=np._NoValue):

std:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2496 to 2501 in b5d6eb4

    
           static PyObject * 
        
           array_stddev(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_std); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 3872 to 3874 in 8cf1f7d

    
           @array_function_dispatch(_std_dispatcher) 
        
           def std(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue, *, 
        
                   where=np._NoValue, mean=np._NoValue, correction=np._NoValue):

sum:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2391 to 2396 in b5d6eb4

    
           static PyObject * 
        
           array_sum(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_sum); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 2336 to 2338 in 8cf1f7d

    
           @array_function_dispatch(_sum_dispatcher) 
        
           def sum(a, axis=None, dtype=None, out=None, keepdims=np._NoValue, 
        
                   initial=np._NoValue, where=np._NoValue):

var:

numpy/numpy/_core/src/multiarray/methods.c

Lines 2503 to 2508 in b5d6eb4

    
           static PyObject * 
        
           array_variance(PyArrayObject *self, 
        
                   PyObject *const *args, Py_ssize_t len_args, PyObject *kwnames) 
        
           { 
        
               NPY_FORWARD_NDARRAY_METHOD(_var); 
        
           }

numpy/numpy/_core/fromnumeric.py

Lines 4076 to 4078 in 8cf1f7d

    
           @array_function_dispatch(_var_dispatcher) 
        
           def var(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue, *, 
        
                   where=np._NoValue, mean=np._NoValue, correction=np._NoValue):

ngoldbaum · 2025-07-24T19:51:38Z

Thanks so much for carefully going through and updating these to reflect the actual implementation.

IMO this is OK to merge and I don’t think this can impact downstream unless they’re parsing docstrings and that’s error-prone anyway.

@jorenham do you agree with that?

jorenham · 2025-07-24T21:30:38Z

Yea I agree that this is a great fix

jorenham · 2025-07-24T21:31:14Z

Thanks Marco!

DOC: Correct more ndarray defaults

ad72f58

github-actions bot added the 04 - Documentation label Jul 21, 2025

MarcoGorelli marked this pull request as ready for review July 21, 2025 12:49

jorenham merged commit 9812a3f into numpy:main Jul 24, 2025
77 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

DOC: Correct more ndarray defaults #29402

DOC: Correct more ndarray defaults #29402

MarcoGorelli commented Jul 21, 2025 •

edited

Loading

Uh oh!

ngoldbaum commented Jul 24, 2025

Uh oh!

jorenham commented Jul 24, 2025

Uh oh!

Uh oh!

jorenham commented Jul 24, 2025

Uh oh!

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

	static PyObject *
	array_all(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_all);
	}

	@array_function_dispatch(_all_dispatcher)
	def all(a, axis=None, out=None, keepdims=np._NoValue, *, where=np._NoValue):

	static PyObject *
	array_any(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_any);
	}

	@array_function_dispatch(_any_dispatcher)
	def any(a, axis=None, out=None, keepdims=np._NoValue, *, where=np._NoValue):

	static PyObject *
	array_clip(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_clip);
	}

	@array_function_dispatch(_clip_dispatcher)
	def clip(a, a_min=np._NoValue, a_max=np._NoValue, out=None, *,
	min=np._NoValue, max=np._NoValue, **kwargs):

	static PyObject *
	array_max(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_amax);
	}

	@array_function_dispatch(_max_dispatcher)
	@set_module('numpy')
	def max(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue,
	where=np._NoValue):

	static PyObject *
	array_min(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_amin);
	}

	@array_function_dispatch(_min_dispatcher)
	def min(a, axis=None, out=None, keepdims=np._NoValue, initial=np._NoValue,
	where=np._NoValue):

	static PyObject *
	array_mean(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_mean);
	}

	@array_function_dispatch(_mean_dispatcher)
	def mean(a, axis=None, dtype=None, out=None, keepdims=np._NoValue, *,
	where=np._NoValue):

	static PyObject *
	array_prod(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_prod);
	}

	@array_function_dispatch(_prod_dispatcher)
	def prod(a, axis=None, dtype=None, out=None, keepdims=np._NoValue,
	initial=np._NoValue, where=np._NoValue):

	static PyObject *
	array_stddev(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_std);
	}

	@array_function_dispatch(_std_dispatcher)
	def std(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue, *,
	where=np._NoValue, mean=np._NoValue, correction=np._NoValue):

	static PyObject *
	array_sum(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_sum);
	}

	@array_function_dispatch(_sum_dispatcher)
	def sum(a, axis=None, dtype=None, out=None, keepdims=np._NoValue,
	initial=np._NoValue, where=np._NoValue):

	static PyObject *
	array_variance(PyArrayObject *self,
	PyObject const args, Py_ssize_t len_args, PyObject *kwnames)
	{
	NPY_FORWARD_NDARRAY_METHOD(_var);
	}

	@array_function_dispatch(_var_dispatcher)
	def var(a, axis=None, dtype=None, out=None, ddof=0, keepdims=np._NoValue, *,
	where=np._NoValue, mean=np._NoValue, correction=np._NoValue):

Uh oh!

DOC: Correct more ndarray defaults #29402

DOC: Correct more ndarray defaults #29402

Conversation

MarcoGorelli commented Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ngoldbaum commented Jul 24, 2025

Uh oh!

jorenham commented Jul 24, 2025

Uh oh!

Uh oh!

jorenham commented Jul 24, 2025

Uh oh!

Uh oh!

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!

MarcoGorelli commented Jul 21, 2025 •

edited

Loading