Searching API needs better documentation

Description

  /** Performs a binary search, returns an index using the same convention as java.util.Arrays.binarySearch. */
final def search[@sp A: Order](as: Array[A], item: A, lower: Int, upper: Int): Int = {

Contributor guide

Tech stack

scala

Domain

documentation

Issue type

documentation

DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.

1

Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.

under 1 hour

Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.

fresh

ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.

clear

Prerequisites

None

Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.

90

Research direction

The issue points out that the docstring for the search method in Spire's array package incorrectly states it uses the same convention as java.util.Arrays.binarySearch, but the actual implementation uses inclusive bounds. The fix should update the docstring to accurately describe the convention (inclusive bounds) and could also mention the difference from Java's implementation. The relevant file is likely in the spire project, possibly in the array package (e.g., Array.scala). No prior PRs or comments exist, so the contributor can simply edit the docstring.