quickwit-oss/tantivy

Explain the purpose of the query-grammar subcrate

Open

#651 opened on Sep 8, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Rust (499 forks)batch import
Hacktoberfestgood first issue

Repository metrics

Stars
 (8,354 stars)
PR merge metrics
 (Avg merge 12d 14h) (20 merged PRs in 30d)

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

Contributor guide

Research direction
Read the source code of the query grammar crate, understand its role in Tantivy's query parsing, write a README explaining its purpose, and add a test for the recursion limit.
Tech stack
rust
Domain
documentationtesting
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitRust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80