-
Notifications
You must be signed in to change notification settings - Fork 95
Update comments #183
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 comments #183
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this huge work. 🎉
There is something that would be important to add to this (maybe in the PR or maybe in another one) which is checking the methods that raise errors.
- Several of them say they raise an
HTTPError
but this has been upgraded with the SDK error handling. They will very often raise aMeiliSearchApiError
instead of this. - Some of them do not mention raising an error even if they do.
This would be worth checking for making these comments and documentation better!
I also added a few suggestions :)
Thanks again
meilisearch/tests/settings/test_settings_attributes_for_faceting_meilisearch.py
Outdated
Show resolved
Hide resolved
meilisearch/tests/settings/test_settings_ranking_rules_meilisearch.py
Outdated
Show resolved
Hide resolved
meilisearch/tests/settings/test_settings_searchable_attributes_meilisearch.py
Outdated
Show resolved
Hide resolved
meilisearch/tests/settings/test_settings_stop_words_meilisearch.py
Outdated
Show resolved
Hide resolved
meilisearch/tests/settings/test_settings_synonyms_meilisearch.py
Outdated
Show resolved
Hide resolved
716b92b
to
c1d8eab
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A suggestion for the description of the Error raised as MeiliSearchApiError:
I suggest:
Raises
------
MeiliSearchApiError
An error containing details about why MeiliSearch can't process your request. MeiliSearch error codes are described here:
https://docs.meilisearch.com/errors/#meilisearch-errors
Note that I changed not only the description, but the link in here. We used to link:
https://docs.meilisearch.com/references/#errors-status-code
I prefer linking this:
https://docs.meilisearch.com/errors/#meilisearch-errors
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!!!!!!
🌮
bors merge |
Build succeeded: |
No description provided.