Improve documentation for Index.add_documents() methods #1057
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.
Pull Request
Related issue
Fixes #1056
What does this PR do?
Index.add_documents_csv()
,Index.add_documents_json()
,Index.add_documents_ndjson()
, andIndex.add_documents_raw()
. These methods require a byte string as input, not a regular string (this wasn't documented clearly).Index.add_documents_raw()
. Instead of atype
variable, the method takes acontent_type
variable; and it's not optional (if it's left out, the server will give a 415 error).PR checklist
Please check if your PR fulfills the following requirements:
Thank you so much for contributing to Meilisearch!