typelevel/spire

Searching API needs better documentation

Open

#786 opened on 2019年4月3日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Scala (1,775 stars) (238 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.