typelevel/spire

Searching API needs better documentation

Open

#786 ouverte le 3 avr. 2019

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Scala (238 forks)batch import
good first issue

Métriques du dépôt

Stars
 (1 775 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Comparez le commentaire de documentation avec l'implémentation réelle et la convention Java. Mettez à jour le commentaire pour clarifier les limites inclusives/exclusives.
Stack technique
scala
Domaine
api
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80