meilisearch/MeiliSearch

API reference: code samples input and output don't match

Ouverte

#6 293 ouverte le 17 mars 2026

Voir sur GitHubGuide contributeur
 (4 commentaires) (0 réaction) (0 personne assignée)Rust (2 542 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (57 572 étoiles)
Métriques de merge PR
 (Merge moyen 11j 20h) (41 PRs mergées en 30 j)

Description

I noticed the API reference code samples’ input and output don’t match, see here:

  • request has limit = 3
  • response has limit = 1

It's acceptable for this example, but it can become confusing for a less self-explanatory API example.

Guide contributeur

Direction de recherche
Mettez à jour l'exemple de code pour avoir des valeurs d'entrée et de sortie correspondantes, par exemple, modifiez la limite de réponse à 3 ou la limite de requête à 1.
Stack technique
Aucun
Domaine
documentation
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.
1
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
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90