`numpy._core._add_newdocs:_array_method_doc`

source: /numpy/_core/_add_newdocs.py :3381

Signature

def _array_method_doc ( name : str , params : str , doc : str ) → None

Summary

Interenal helper function for adding docstrings to a common method of numpy.ndarray and numpy.generic.

Extended Summary

The provided docstring will be added to the given numpy.ndarray method. For the numpy.generic method, a shorter docstring indicating that it is identical to the ndarray method will be created. Both methods will have a proper and identical __text_signature__.

Parameters

name : str: Name of the method.
params : str: Parameter signature for the method without parentheses, for example, "a, /, dtype=None, *, copy=False". Parameter defaults must be understood by ast.literal_eval, i.e. strings, bytes, numbers, tuples, lists, dicts, sets, booleans, or None.
doc : str: The full docstring for the ndarray method.

Aliases

numpy._core._add_newdocs._array_method_doc