Skip to content

Commit c449b55

Browse files
committed
docs: fix markup
1 parent ee49db9 commit c449b55

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/array_api_stubs/_draft/sorting_functions.py

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,23 @@ def argsort(
1313
Parameters
1414
----------
1515
x: array
16-
input array. *Should* have a real-valued data type.
16+
input array. **Should** have a real-valued data type.
1717
axis: int
18-
axis along which to sort. If set to ``-1``, the function *must* sort along the last axis. Default: ``-1``.
18+
axis along which to sort. If set to ``-1``, the function **must** sort along the last axis. Default: ``-1``.
1919
descending: bool
20-
sort order. If ``True``, the returned indices *must* sort ``x`` in descending order (by value). If ``False``, the returned indices *must* sort ``x`` in ascending order (by value). Default: ``False``.
20+
sort order. If ``True``, the returned indices **must** sort ``x`` in descending order (by value). If ``False``, the returned indices **must** sort ``x`` in ascending order (by value). Default: ``False``.
2121
stable: bool
22-
sort stability. If ``True``, the returned indices *must* maintain the relative order of ``x`` values which compare as equal. If ``False``, the returned indices *may* maintain the relative order of ``x`` values which compare as equal (i.e., the relative order of ``x`` values which compare as equal is implementation-dependent). Default: ``True``.
22+
sort stability. If ``True``, the returned indices **must** maintain the relative order of ``x`` values which compare as equal. If ``False``, the returned indices **may** maintain the relative order of ``x`` values which compare as equal (i.e., the relative order of ``x`` values which compare as equal is implementation-dependent). Default: ``True``.
2323
2424
Returns
2525
-------
2626
out: array
27-
an array of indices. The returned array *must* have the same shape as ``x``. The returned array *must* have the default array index data type.
27+
an array of indices. The returned array **must** have the same shape as ``x``. The returned array **must** have the default array index data type.
2828
2929
Notes
3030
-----
3131
32-
- For backward compatibility, conforming implementations *may* support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see :ref:`complex-number-ordering`).
32+
- For backward compatibility, conforming implementations **may** support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see :ref:`complex-number-ordering`).
3333
"""
3434

3535

@@ -42,21 +42,21 @@ def sort(
4242
Parameters
4343
----------
4444
x: array
45-
input array. *Should* have a real-valued data type.
45+
input array. **Should** have a real-valued data type.
4646
axis: int
47-
axis along which to sort. If set to ``-1``, the function *must* sort along the last axis. Default: ``-1``.
47+
axis along which to sort. If set to ``-1``, the function **must** sort along the last axis. Default: ``-1``.
4848
descending: bool
49-
sort order. If ``True``, the array *must* be sorted in descending order (by value). If ``False``, the array *must* be sorted in ascending order (by value). Default: ``False``.
49+
sort order. If ``True``, the array **must** be sorted in descending order (by value). If ``False``, the array **must** be sorted in ascending order (by value). Default: ``False``.
5050
stable: bool
51-
sort stability. If ``True``, the returned array *must* maintain the relative order of ``x`` values which compare as equal. If ``False``, the returned array *may* maintain the relative order of ``x`` values which compare as equal (i.e., the relative order of ``x`` values which compare as equal is implementation-dependent). Default: ``True``.
51+
sort stability. If ``True``, the returned array **must** maintain the relative order of ``x`` values which compare as equal. If ``False``, the returned array **may** maintain the relative order of ``x`` values which compare as equal (i.e., the relative order of ``x`` values which compare as equal is implementation-dependent). Default: ``True``.
5252
5353
Returns
5454
-------
5555
out: array
56-
a sorted array. The returned array *must* have the same data type and shape as ``x``.
56+
a sorted array. The returned array **must** have the same data type and shape as ``x``.
5757
5858
Notes
5959
-----
6060
61-
- For backward compatibility, conforming implementations *may* support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see :ref:`complex-number-ordering`).
61+
- For backward compatibility, conforming implementations **may** support complex numbers; however, inequality comparison of complex numbers is unspecified and thus implementation-dependent (see :ref:`complex-number-ordering`).
6262
"""

0 commit comments

Comments
 (0)