Merge #1348

1348: docs: modification of certain returns r=bidoubiwa a=MoskalykA

# Pull Request

## Related issue
Fixes #1346 

## What does this PR do?
- It modifies some returns

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: MoskalykA <[email protected]>

Author: meili-bors[bot]

src/indexes.ts

@@ -386,7 +386,7 @@ class Index<T = Record<string, any>> {
    * @param {Array<Document<T>>} documents Array of Document objects to add/replace
    * @param {DocumentOptions} options? Options on document addition
    *
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async addDocuments(
     documents: Array<Document<T>>,
@@ -428,7 +428,7 @@ class Index<T = Record<string, any>> {
    * @method updateDocuments
    * @param {Array<Document<Partial<T>>>} documents Array of Document objects to add/update
    * @param {DocumentOptions} options? Options on document update
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateDocuments(
     documents: Array<Document<Partial<T>>>,
@@ -469,7 +469,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method deleteDocument
    * @param {string | number} documentId Id of Document to delete
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async deleteDocument(documentId: string | number): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents/${documentId}`
@@ -485,7 +485,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method deleteDocuments
    * @param {string[] | number[]} documentsIds Array of Document Ids to delete
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async deleteDocuments(
     documentsIds: string[] | number[]
@@ -501,7 +501,7 @@ class Index<T = Record<string, any>> {
    * Delete all documents of an index
    * @memberof Index
    * @method deleteAllDocuments
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async deleteAllDocuments(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/documents`
@@ -533,7 +533,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateSettings
    * @param {Settings} settings Object containing parameters with their updated values
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateSettings(settings: Settings): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings`
@@ -548,7 +548,7 @@ class Index<T = Record<string, any>> {
    * Reset settings.
    * @memberof Index
    * @method resetSettings
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetSettings(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings`
@@ -579,7 +579,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updatePagination
    * @param {PaginationSettings} pagination Pagination object
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updatePagination(
     pagination: PaginationSettings
@@ -594,7 +594,7 @@ class Index<T = Record<string, any>> {
    * Reset the pagination settings.
    * @memberof Index
    * @method resetPagination
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetPagination(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/pagination`
@@ -622,7 +622,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateSynonyms
    * @param {Synonyms} synonyms Mapping of synonyms with their associated words
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/synonyms`
@@ -635,7 +635,7 @@ class Index<T = Record<string, any>> {
    * Reset the synonym list to be empty again
    * @memberof Index
    * @method resetSynonyms
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetSynonyms(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/synonyms`
@@ -666,7 +666,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateStopWords
    * @param {StopWords} stopWords Array of strings that contains the stop-words.
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateStopWords(stopWords: StopWords): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/stop-words`
@@ -679,7 +679,7 @@ class Index<T = Record<string, any>> {
    * Reset the stop-words list to be empty again
    * @memberof Index
    * @method resetStopWords
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetStopWords(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/stop-words`
@@ -710,7 +710,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateRankingRules
    * @param {RankingRules} rankingRules Array that contain ranking rules sorted by order of importance.
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateRankingRules(rankingRules: RankingRules): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/ranking-rules`
@@ -723,7 +723,7 @@ class Index<T = Record<string, any>> {
    * Reset the ranking rules list to its default value
    * @memberof Index
    * @method resetRankingRules
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetRankingRules(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/ranking-rules`
@@ -754,7 +754,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateDistinctAttribute
    * @param {DistinctAttribute} distinctAttribute Field name of the distinct-attribute
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateDistinctAttribute(
     distinctAttribute: DistinctAttribute
@@ -769,7 +769,7 @@ class Index<T = Record<string, any>> {
    * Reset the distinct-attribute.
    * @memberof Index
    * @method resetDistinctAttribute
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetDistinctAttribute(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/distinct-attribute`
@@ -800,7 +800,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateFilterableAttributes
    * @param {FilterableAttributes} filterableAttributes Array of strings containing the attributes that can be used as filters at query time
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateFilterableAttributes(
     filterableAttributes: FilterableAttributes
@@ -815,7 +815,7 @@ class Index<T = Record<string, any>> {
    * Reset the filterable-attributes.
    * @memberof Index
    * @method resetFilterableAttributes
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetFilterableAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/filterable-attributes`
@@ -846,7 +846,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateSortableAttributes
    * @param {SortableAttributes} sortableAttributes Array of strings containing the attributes that can be used to sort search results at query time
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateSortableAttributes(
     sortableAttributes: SortableAttributes
@@ -861,7 +861,7 @@ class Index<T = Record<string, any>> {
    * Reset the sortable-attributes.
    * @memberof Index
    * @method resetSortableAttributes
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetSortableAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/sortable-attributes`
@@ -892,7 +892,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateSearchableAttributes
    * @param {SearchableAttributes} searchableAttributes Array of strings that contains searchable attributes sorted by order of importance(most to least important)
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateSearchableAttributes(
     searchableAttributes: SearchableAttributes
@@ -907,7 +907,7 @@ class Index<T = Record<string, any>> {
    * Reset the searchable-attributes.
    * @memberof Index
    * @method resetSearchableAttributes
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetSearchableAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/searchable-attributes`
@@ -938,7 +938,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateDisplayedAttributes
    * @param {DisplayedAttributes} displayedAttributes Array of strings that contains attributes of an index to display
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateDisplayedAttributes(
     displayedAttributes: DisplayedAttributes
@@ -953,7 +953,7 @@ class Index<T = Record<string, any>> {
    * Reset the displayed-attributes.
    * @memberof Index
    * @method resetDisplayedAttributes
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetDisplayedAttributes(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/displayed-attributes`
@@ -1032,7 +1032,7 @@ class Index<T = Record<string, any>> {
    * @memberof Index
    * @method updateFaceting
    * @param {Faceting} faceting Faceting index settings object
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async updateFaceting(faceting: Faceting): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/faceting`
@@ -1045,7 +1045,7 @@ class Index<T = Record<string, any>> {
    * Reset the faceting settings.
    * @memberof Index
    * @method resetFaceting
-   * @returns {Promise<EnqueuedTask>} Promise containing object of the enqueued task
+   * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
   async resetFaceting(): Promise<EnqueuedTask> {
     const url = `indexes/${this.uid}/settings/faceting`