DOC: clarify np.searchsorted documentation and add example for sorter

HabibiHye · HabibiHye · commit a3a476922ebf · 2024-09-12T21:35:02.000-04:00
diff --git a/numpy/_core/fromnumeric.py b/numpy/_core/fromnumeric.py
@@ -1540,7 +1540,7 @@ def searchsorted(a, v, side='left', sorter=None):
     >>> a = np.array([40, 10, 20, 30])
     >>> sorter = np.argsort(a)
     >>> sorter
-    array([1, 2, 3, 0])  # Indices that would sort the array
+    array([1, 2, 3, 0])  # Indices that would sort the array 'a'
     >>> np.searchsorted(a, 25, sorter=sorter)
     2
     >>> a[sorter[np.searchsorted(a, 25, sorter=sorter)]]

Original file line number	Diff line number	Diff line change
`@@ -1540,7 +1540,7 @@ def searchsorted(a, v, side='left', sorter=None):`
`1540`	`1540`	`>>> a = np.array([40, 10, 20, 30])`
`1541`	`1541`	`>>> sorter = np.argsort(a)`
`1542`	`1542`	`>>> sorter`
`1543`		`- array([1, 2, 3, 0]) # Indices that would sort the array`
	`1543`	`+ array([1, 2, 3, 0]) # Indices that would sort the array 'a'`
`1544`	`1544`	`>>> np.searchsorted(a, 25, sorter=sorter)`
`1545`	`1545`	`2`
`1546`	`1546`	`>>> a[sorter[np.searchsorted(a, 25, sorter=sorter)]]`