meilisearch/MeiliSearch

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

Open

#6.293 aberto em 17 de mar. de 2026

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Rust (733 forks)batch import
documentationgood first issue

Métricas do repositório

Stars
 (20.887 stars)
Métricas de merge de PR
 (Mesclagem média 4d 3h) (37 fundiu PRs em 30d)

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.

Guia do colaborador

Direção de pesquisa
Atualize o exemplo de código para ter valores de entrada e saída correspondentes, por exemplo, altere o limite de resposta para 3 ou o limite de solicitação para 1.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90