Skip to content

Fix compatibility message after Meilisearch v1 #688

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

Merged
merged 2 commits into from
Feb 20, 2023
Merged

Conversation

meili-bot
Copy link
Contributor

Related to this issue: meilisearch/integration-guides#237

Based on the discussion from the integration-guides issue, this is now the default message for Meilisearch v1 era.

@meili-bot meili-bot added the skip-changelog The PR will not appear in the release changelogs label Feb 16, 2023
@brunoocasali brunoocasali marked this pull request as ready for review February 16, 2023 21:20
@@ -197,7 +197,7 @@ index.search(

## 🤖 Compatibility with Meilisearch

This package only guarantees the compatibility with the [version v1.0.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v1.0.0).
This package guarantees compatibility with [version v1.x of Meilisearch](https://github.com/meilisearch/meilisearch/releases/latest), but some features may not be present. Please check the [issues](https://github.com/meilisearch/meilisearch-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement) for more info.
Copy link
Collaborator

Choose a reason for hiding this comment

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

https://github.com/meilisearch/meilisearch-python/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22+label%3Aenhancement brings up no issues, but there are some labeled enhancement. I think this link is searching for things labeled with both good first issue and enhancement.

It may be the case that a new feature isn't labeled good first issue, it's also possible an enhancement won't be for a previously missing feature specifically from the Meilisearch API. Maybe just link to the issues page and not specific labels?

Copy link
Member

Choose a reason for hiding this comment

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

Some SDKs have a lot of issues, so if we don't filter, will be hard for the user to understand which "Meilisearch feature" is missing. But the thing is all of the issues generated during the pre-release period, will contain both labels.

Maybe one good improvement is to adopt a new label, but I don't want to introduce a new label right now.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe one good improvement is to adopt a new label, but I don't want to introduce a new label right now.

I agree if we add this link to all READMEs it might be better to create a specific label for this link like missing-feature or something

@alallema
Copy link
Contributor

bors merge

@bors
Copy link
Contributor

bors bot commented Feb 20, 2023

@bors bors bot merged commit 3b5c2e8 into main Feb 20, 2023
@bors bors bot deleted the meili-bot/compatibility branch February 20, 2023 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog The PR will not appear in the release changelogs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants