-
Notifications
You must be signed in to change notification settings - Fork 251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
review filtering guide #2061
review filtering guide #2061
Conversation
Co-authored-by: gui machiavelli <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we're almost there, but I have an extra comment regarding document structure.
In "Filter basics" we introduce two important terms: filter expressions and conditions. Though we give extensive definitions of conditions, filter expressions are only briefly defined mid-sentence on L#60. Since we use the term "filter expressions" throughout the document, I'm afraid inattentive users might have a hard time finding that definition because it's so easily missed—a quick scroll will not reveal any relevant headings and they will have to do a cmd+f and type "expression", possibly having to skip a few matches until they find a satisfactory explanation.
I can think of at least two ways of helping these users:
- having a short section named "Filter expressions" with a definition and a code sample. For example:
### Filter expressions
Filter expressions combine multiple conditions with operators. They are always written in the `condition1 OPERATOR condition2` format:
```
genre = horror AND release_year > 2001
```
- adding a brief definition of filter expressions to "Combining filter expressions". Could also involve changing this heading to something like "Combining conditions into filter expressions" (probably not a good title, but you get the idea)
I think #1 is simpler, but might be overkill.
Co-authored-by: gui machiavelli <[email protected]>
@dichotommy, you mentioned you wanted to review this. Will you have time for it? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good! I'm submitting half my review now so you can get started on it, will be back later to review the rest.
Co-authored-by: Tommy <[email protected]>
Co-authored-by: Tommy <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On y va! 🚀
bors merge |
2061: review filtering guide r=maryamsulemani97 a=maryamsulemani97 closes #1902, #860, #837, and #1850 - moves all operators to a new heading - removes SQL syntax and combines it with the curl code samples - replaces amazon and imdb images for facets with meilisearch demo images - removes unused images in `.vuepress/public/faceted-search` - remove redundant code samples <hr> - Improve coherence between dataset and examples - A sample document was added as part of #2050 with `rating` and `director` fields - This PR uses `movie_ratings` instead of `movies` to clarify that this is a separate dataset - `faceted_search_facets_1` still uses `movies` as this code sample is used in the API reference as well Co-authored-by: Maryam Sulemani <[email protected]> Co-authored-by: Maryam <[email protected]> Co-authored-by: maryamsulemani97 <[email protected]>
This PR was included in a batch that successfully built, but then failed to merge into main. It will not be retried. Additional information: Response status code: 422
{"message":"1 review requesting changes and 1 approving review by reviewers with write access.","documentation_url":"https://docs.github.com/articles/about-protected-branches"} |
bors merge |
Build succeeded: |
closes #1902, #860, #837, and #1850
.vuepress/public/faceted-search
rating
anddirector
fieldsmovie_ratings
instead ofmovies
to clarify that this is a separate datasetfaceted_search_facets_1
still usesmovies
as this code sample is used in the API reference as well