typelevel/spire

Searching API needs better documentation

Open

#786 aperta il 3 apr 2019

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Scala (238 fork)batch import
good first issue

Metriche repository

Star
 (1775 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Confronta il commento della documentazione con l'implementazione effettiva e la convenzione Java. Aggiorna il commento per chiarire i limiti inclusivi/esclusivi.
Tech stack
scala
Dominio
api
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80