quickwit-oss/tantivy

Explain the purpose of the query-grammar subcrate

Open

#651 ouverte le 8 sept. 2019

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Rust (499 forks)batch import
Hacktoberfestgood first issue

Métriques du dépôt

Stars
 (8 354 stars)
Métriques de merge PR
 (Merge moyen 12j 14h) (20 PRs mergées en 30 j)

Description

Since query-grammar has been moved to a separate crate, we should explain what it's responsible for and how it fits with the rest of the library architecture.

We also moved the recursion_limit to this subcrate, the value of 100 is still prone to failure, which we should test https://github.com/tantivy-search/tantivy/blob/master/query-grammar/src/lib.rs#L1

  • Add a test for recursion limit in query-grammar
  • Add a Readme to query-grammar to explain what it does
  • Edit query-grammar/Cargo.toml to reflect correct keywords etc

Guide contributeur

Direction de recherche
Lisez le code source de la crate query grammar, comprenez son rôle dans l'analyse des requêtes de Tantivy, écrivez un README expliquant son objectif et ajoutez un test pour la limite de récursion.
Stack technique
rust
Domaine
documentationtesting
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.
Une demi journée
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
GitRust
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80