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.

Sign up for GitHub

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

Fix compatibility message after Meilisearch v1 #688

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15ae4e6
Update README.md
meili-bot Feb 16, 2023
d15bd84
Remove /tag from Meilisearch engine link
brunoocasali Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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


## 💡 Learn more

Expand Down