Skip to content

Commit a895a2b

Browse files
Merge #1058
1058: Update JSDoc comments for each function r=bidoubiwa a=blenderskool JSDoc comments for all the user-facing functions are updated to include ``@param`` and ``@returns`` tags with appropriate descriptions. Descriptions for some of these tags were referenced from the [official API documentation](https://docs.meilisearch.com/reference/api/) I haven't made these updates to the functions not exposed by the library, wasn't sure if it was needed there as well. I don't think I missed any other function, please let me know if I did or made any typos. 🙂 Fixes #325 Co-authored-by: Akash Hamirwasia <[email protected]>
2 parents 30d9bfd + 3bbbc24 commit a895a2b

File tree

3 files changed

+145
-6
lines changed

3 files changed

+145
-6
lines changed

0 commit comments

Comments
 (0)