typelevel/spire

Searching API needs better documentation

Open

#786 创建于 2019年4月3日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Scala (1,775 star) (238 fork)batch import
good first issue

描述

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.

贡献者指南

技术栈
scala
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
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.