Skip to content
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

Jump to bottom

Update js-docs comment on enqueued tasks #1346

Closed
bidoubiwa opened this issue Oct 4, 2022 · 1 comment · Fixed by #1348
Closed

Update js-docs comment on enqueued tasks #1346

bidoubiwa opened this issue Oct 4, 2022 · 1 comment · Fixed by #1348
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@bidoubiwa
Copy link
Contributor

⚠️ Once #1344 and #1339 are merged

Since EnqueuedTask is now a Class and not an object, the js-docs should be updated accordingly.

Everywhere the following is written

meilisearch-js/src/indexes.ts

Line 387 in 1481506

* @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task

It should be changed with something more relevant. For example:

Promise containing an EnqueuedTask

Or something else if you think its better
@bidoubiwa bidoubiwa added enhancement New feature or request good first issue Good for newcomers hacktoberfest labels Oct 4, 2022
@MoskalykA
Copy link
Contributor

I'll take care of it once the two changes are made

@MoskalykA MoskalykA mentioned this issue Oct 5, 2022
Merged
3 tasks
@meili-bors meili-bors bot closed this as completed in 807a6d8 Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: modification of certain returns
2 participants
@bidoubiwa @MoskalykA