Skip to content
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

Update known_limitations.mdx #2530

Merged
merged 3 commits into from
Aug 28, 2023
Merged

Conversation

RyanGoudie01
Copy link
Contributor

Implement New known limitation about facet search.

Pull Request

Related issue

Fixes #2529 >

What does this PR do?

  • Updated known_limitations.mdx to include information regarding the limitation on the facet search. Included a description of the Limitation , Explanation and detailed that it may be considered for future implementation.

PR checklist

Please check if your PR fulfils the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Implement New known limitation about facet search.
@guimachiavelli
Copy link
Member

Hi @RyanGoudie01! Thanks for the PR, it's really appreciated. I just returned from my holidays, but wanted to let you know I'll be looking into it sometime during this week.

Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @RyanGoudie01!

I made a couple of suggestions to your PR so it better addresses the issues and confusion reported by users.

I got the impression from your past messages you might be interested in documentation. If that's the case, here's a couple of general notes you may find interesting:

  • when referring to things that exist in the code, like variable or functions, format them correctly to indicate that. In markdown, which we use in this repository, that would be backticks (`). For example: maxValuesPerFacet;
  • we avoid using "currently" as much as possible—the documentation's task is to help people use our software now, so in most cases "currently" is implied and unnecessary;

Thanks again!

learn/inner_workings/known_limitations.mdx Outdated Show resolved Hide resolved
RyanGoudie01 and others added 2 commits August 24, 2023 10:45
Update commit with suggested changes

Co-authored-by: gui machiavelli <[email protected]>
Update with suggested change

Co-authored-by: gui machiavelli <[email protected]>
Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking the time to review my comments, @RyanGoudie01!

PR approved, merging

@guimachiavelli guimachiavelli merged commit 87e6e6a into meilisearch:main Aug 28, 2023
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

New known limitation about facet search
2 participants