meilisearch-js icon indicating copy to clipboard operation
meilisearch-js copied to clipboard

Improve JsDoc comments

Open bidoubiwa opened this issue 3 years ago • 0 comments

Currently, the jsDocs comments are quite rudimentary and would win by being more complete.

For example, default values could be added where they are present

Example:

  /**
   * ...
   * @param {IndexesQuery} [parameters={}] - Parameters to browse the indexes
   * 

Here we added [parameters={}] as the default value of the parameter.

Other improvements are code examples directly inside the comments. Which would make generating a documentation in the long run easier.

bidoubiwa avatar Jun 27 '22 11:06 bidoubiwa