docs: Minor fixes

AoumiS · Jan 10, 2020 · a84be0a · a84be0a
1 parent 67597a5
commit a84be0a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/src/queries/full-text-queries/match-query.js b/src/queries/full-text-queries/match-query.js
@@ -33,6 +33,10 @@ const invalidZeroTermsQueryParam = invalidParam(
  * @example
  * const matchQry = esb.matchQuery('message', 'to be or not to be');
  *
+ * @example
+ * // Providing additional parameters:
+ * const qry = esb.matchQuery('message', 'this is a test').operator('and');
+ *
  * @extends MonoFieldQueryBase
  */
 class MatchQuery extends MonoFieldQueryBase {
@@ -82,9 +86,6 @@ class MatchQuery extends MonoFieldQueryBase {
      * the number of one character changes that need to be made to one string to make it
      * the same as another string.
      *
-     * @example
-     * const qry = esb.matchQuery('message', 'this is a test').operator('and');
-     *
      * @param {number|string} factor Can be specified either as a number, or the maximum
      * number of edits, or as `AUTO` which generates an edit distance based on the length
      * of the term.

diff --git a/src/queries/full-text-queries/multi-match-query.js b/src/queries/full-text-queries/multi-match-query.js
@@ -85,7 +85,7 @@ class MultiMatchQuery extends FullTextQueryBase {
      *
      * @example
      * // Specify fields with wildcards
-     *const qry = esb.multiMatchQuery(['title', '*_name'], 'Will Smith');
+     * const qry = esb.multiMatchQuery(['title', '*_name'], 'Will Smith');
      *
      * @param {Array<string>} fields The fields to be queried
      * @returns {MultiMatchQuery} returns `this` so that calls can be chained.

diff --git a/src/queries/full-text-queries/simple-query-string-query.js b/src/queries/full-text-queries/simple-query-string-query.js
@@ -18,7 +18,7 @@ const ES_REF_URL =
  * )
  *     .analyzer('snowball')
  *     .fields(['body^5', '_all'])
- *     .defaultOperator();
+ *     .defaultOperator('and');
  *
  * @param {string=} queryString The query string
  *