chore(algoliasearch): adds warning about javascript v4 #300
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Haroenv
reviewed
Jan 15, 2020
| @@ -117,6 +117,8 @@ var autocomplete = require('autocomplete.js'); | |||
| 1. Include `autocomplete.min.js` | |||
| 1. Initialize the auto-completion menu calling the `autocomplete` function | |||
|
|
|||
| **Warning**: `autocomplete.js` is not compatible with the latest version algoliasearch v4, therefore we highly recommend you use algoliasearch v3 as specified in the code snippet below. | |||
There was a problem hiding this comment.
it says latest here, but it's not yet released. Should it maybe say "upcoming"?
There was a problem hiding this comment.
No. Let's just merge this once is released.
There was a problem hiding this comment.
Makes sense, but it could also be useful to already say now that the v0 isn't compatible
There was a problem hiding this comment.
v4 is not public yet so it's fine to postpone this warning.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request warns users that the autocomplete won't be compatible with algoliasearch v4.