From d0fe9dea6177746b77633553be606cdcae601216 Mon Sep 17 00:00:00 2001 From: Tamo Date: Thu, 4 Nov 2021 14:43:36 +0100 Subject: [PATCH] update the readme --- filter_parser/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/filter_parser/README.md b/filter_parser/README.md index 3ba9d8f23..44ffdada3 100644 --- a/filter_parser/README.md +++ b/filter_parser/README.md @@ -2,7 +2,7 @@ This workspace is dedicated to the parsing of the MeiliSearch filters. -Most of the code and explanation are in the [src/lib.rs]. Especially, the BNF of the filters at the top of this file. +Most of the code and explanation are in the [`lib.rs`](./src/lib.rs). Especially, the BNF of the filters at the top of this file. The parser use [nom](https://docs.rs/nom/) to do most of its work and [nom-locate](https://docs.rs/nom_locate/) to keep track of what we were doing when we encountered an error. @@ -31,5 +31,6 @@ cargo fuzz run parse ## What to do if you find a bug in the parser -- Write a test at the end of the [src/lib.rs] to ensure it never happens again. -- Add a file in [fuzz/corpus/parse/] with your filter to help the fuzzer finding new bug. +- Write a test at the end of the [`lib.rs`](./src/lib.rs) to ensure it never happens again. +- Add a file in [the corpus directory](./fuzz/corpus/parse/) with your filter to help the fuzzer finding new bug. Since this directory is going to be heavily polluted by the execution of the fuzzer it's in the gitignore and you'll need to force push your new test. + Since this directory is going to be heavily polluted by the execution of the fuzzer it's in the gitignore and you'll need to force add your new test.