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.
Searching API needs better documentation · typelevel/spire#786 | Good First Issue