aboutsummaryrefslogtreecommitdiff
path: root/docs/arrays.md
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2024-09-11 15:07:37 -0400
committerBruce Hill <bruce@bruce-hill.com>2024-09-11 15:07:37 -0400
commit91f1d53a4e60e35d4a7617b62eab761231cb680d (patch)
tree46f595199a13eb62797d95c8ae2997a9ade3c10e /docs/arrays.md
parent0471e4444a7a58956dec2a530aa939e861902cdf (diff)
Update docs
Diffstat (limited to 'docs/arrays.md')
-rw-r--r--docs/arrays.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/arrays.md b/docs/arrays.md
index 8ec047e7..bb5af7c1 100644
--- a/docs/arrays.md
+++ b/docs/arrays.md
@@ -251,7 +251,8 @@ binary_search(arr: [T], by=T.compare) -> Int
**Returns:**
Assuming the input array is sorted according to the given comparison function,
return the index where the given item would be inserted to maintain the sorted
-order.
+order. That is, if the item is found, return its index, otherwise return the
+place where it would be found if it were inserted and the array were sorted.
**Example:**
```markdown