Skip to content

DOC: note stringdtype output support in np.strings docstrings #26067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 18, 2024
Merged

DOC: note stringdtype output support in np.strings docstrings #26067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions numpy/_core/code_generators/ufunc_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4904,8 +4904,8 @@ def add_newdoc(place, name, doc):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input
types
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types
$OUT_SCALAR_2

See Also
Expand Down Expand Up @@ -4943,7 +4943,8 @@ def add_newdoc(place, name, doc):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input type
$OUT_SCALAR_2

See Also
Expand Down Expand Up @@ -4978,7 +4979,8 @@ def add_newdoc(place, name, doc):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input type
$OUT_SCALAR_2

See Also
Expand Down Expand Up @@ -5012,7 +5014,8 @@ def add_newdoc(place, name, doc):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input type
$OUT_SCALAR_2

See Also
Expand Down
76 changes: 46 additions & 30 deletions numpy/_core/strings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@ def multiply(a, i):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input types
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

Examples
--------
Expand Down Expand Up @@ -189,7 +190,8 @@ def mod(a, values):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input types
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

"""
return _to_bytes_or_str_array(
Expand Down Expand Up @@ -310,7 +312,7 @@ def rindex(a, sub, start=0, end=None):
Returns
-------
out : ndarray
Output array of ints.
Output array of ints.

See Also
--------
Expand Down Expand Up @@ -551,7 +553,8 @@ def expandtabs(a, tabsize=8):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input type

See Also
--------
Expand Down Expand Up @@ -593,7 +596,8 @@ def center(a, width, fillchar=' '):
Returns
-------
out : ndarray
Output array of str or unicode, depending on the type of ``a``
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -651,7 +655,8 @@ def ljust(a, width, fillchar=' '):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -706,7 +711,8 @@ def rjust(a, width, fillchar=' '):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -760,7 +766,8 @@ def zfill(a, width):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input type

See Also
--------
Expand Down Expand Up @@ -802,7 +809,8 @@ def lstrip(a, chars=None):
Returns
-------
out : ndarray
Output array of ``bytes_`` or ``str_`` dtype
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -847,7 +855,8 @@ def rstrip(a, chars=None):
Returns
-------
out : ndarray
Output array of ``bytes_`` or ``str_`` dtype
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -887,7 +896,8 @@ def strip(a, chars=None):
Returns
-------
out : ndarray
Output array of ``bytes_`` or ``str_`` dtype
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -928,8 +938,9 @@ def upper(a):

Returns
-------
out : ndarray, {str, unicode}
Output array of str or unicode, depending on input type
out : ndarray
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -962,8 +973,9 @@ def lower(a):

Returns
-------
out : ndarray, {str, unicode}
Output array of str or unicode, depending on input type
out : ndarray
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -997,8 +1009,9 @@ def swapcase(a):

Returns
-------
out : ndarray, {str, unicode}
Output array of str or unicode, depending on input type
out : ndarray
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -1035,8 +1048,8 @@ def capitalize(a):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input
types
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -1075,7 +1088,8 @@ def title(a):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input type
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -1113,7 +1127,8 @@ def replace(a, old, new, count=-1):
Returns
-------
out : ndarray
Output array of ``str_`` or ``bytes_`` dtype
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -1164,7 +1179,8 @@ def _join(sep, seq):
Returns
-------
out : ndarray
Output array of str or unicode, depending on input types
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types

See Also
--------
Expand Down Expand Up @@ -1250,7 +1266,7 @@ def _rsplit(a, sep=None, maxsplit=None):
Returns
-------
out : ndarray
Array of list objects
Array of list objects

See Also
--------
Expand Down Expand Up @@ -1320,10 +1336,10 @@ def _partition(a, sep):

Returns
-------
out : ndarray, {str, unicode}
Output array of str or unicode, depending on input type.
The output array will have an extra dimension with 3
elements per input element.
out : ndarray
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types. The output array will have an extra
dimension with 3 elements per input element.

Examples
--------
Expand Down Expand Up @@ -1362,9 +1378,9 @@ def _rpartition(a, sep):
Returns
-------
out : ndarray
Output array of string or unicode, depending on input
type. The output array will have an extra dimension with
3 elements per input element.
Output array of ``StringDType``, ``bytes_`` or ``str_`` dtype,
depending on input types. The output array will have an extra
dimension with 3 elements per input element.

See Also
--------
Expand Down