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

Document multi search usage #344

Merged
merged 1 commit into from Feb 29, 2024

Conversation

ellnix
Copy link
Collaborator

@ellnix ellnix commented Feb 29, 2024

Fixes #337

@ellnix ellnix added the documentation Improvements or additions to documentation label Feb 29, 2024
@ellnix
Copy link
Collaborator Author

ellnix commented Feb 29, 2024

I will try to make a new release as soon as this is merged, since otherwise we will have a section of the README that does not work in production.

Copy link

codecov bot commented Feb 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.22%. Comparing base (b5983bd) to head (37c894c).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #344   +/-   ##
=======================================
  Coverage   90.22%   90.22%           
=======================================
  Files          13       13           
  Lines         757      757           
=======================================
  Hits          683      683           
  Misses         74       74           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

README.md Outdated
@@ -240,6 +241,58 @@ Book.search('*', sort: ['title:asc'])

👉 Don't forget to set up the `sortable_attributes` option in the `meilisearch` block of your model.

## 🔍🔍 Multi search

MeiliSearch supports searching multiple models at the same time (see [🔍 Custom search](#-custom-search) for search options):
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
MeiliSearch supports searching multiple models at the same time (see [🔍 Custom search](#-custom-search) for search options):
Meilisearch supports searching multiple models at the same time (see [🔍 Custom search](#-custom-search) for search options):

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Ooops sorry, old habits die hard lol

Copy link
Member

Choose a reason for hiding this comment

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

hahaha no issue!

Also, if you have time you could put in your big breaking changing the main class name to Meilisearch instead of MeiliSearch. Not only here but in the ruby gem as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That should be easy, just a find and replace. But it will be a huge breaking change, possibly v1?

Copy link
Member

Choose a reason for hiding this comment

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

I don't want to think about making a v1 right now, especially since we will introduce a lot of new stuff. Let's do all the breaking and wait for them to sink into the users. Also we will be able to understand if the changes had the effect we wanted :)

Copy link
Member

@brunoocasali brunoocasali left a comment

Choose a reason for hiding this comment

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

bors merge

@meili-bors meili-bors bot merged commit 3198ac8 into meilisearch:main Feb 29, 2024
12 checks passed
@ellnix ellnix added the skip-changelog The PR will not appear in the release changelogs label Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document multi_search interface in README
2 participants