quickwit-oss/tantivy

Explain the purpose of the query-grammar subcrate

Open

#651 建立於 2019年9月8日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Rust (8,354 star) (499 fork)batch import
Hacktoberfestgood first issue

描述

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

貢獻者指南

技術棧
rust
領域
documentationtesting
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic Rustunderstanding of tantivy architecture
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65
研究方向
Examine the query grammar subcrate at query grammar/src/lib.rs to understand its current responsibilities. Check the main crate's architecture to see how query grammar fits. Write a README explaining its purpose. Add a test for recursion limit, which may involve using the crate's parsing functions to ensure recursion depth is handled. Update Cargo.toml with appropriate keywords and description.