typelevel/spire

Searching API needs better documentation

Open

#786 opened on Apr 3, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (238 forks)batch import
good first issue

Repository metrics

Stars
 (1,775 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We state

  /** 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 = {

However, our convention is to search the interval [lower, upper] inclusive, whereas java.util.Arrays.binarySearch excludes the upper bound.

Contributor guide

Research direction
Compare the documentation comment with the actual implementation and the Java convention. Update the comment to clarify the inclusive/exclusive bounds.
Tech stack
scala
Domain
api
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80