Apply suggestions from code review

Co-authored-by: James Rodewig <[email protected]>

specification/_global/search/_types/hits.ts

@@ -105,8 +105,8 @@ export enum TotalHitsRelation {
 
 export class InnerHits {
   /**
-   * The name to be used for the particular inner hit definition in the response.
-   * Useful when multiple inner hits have been defined in a single search request.
+   * The name for the particular inner hit definition in the response.
+   * Useful when a search request contains multiple inner hits.
    */
   name?: Name
   /**

specification/_types/query_dsl/fulltext.ts

@@ -145,7 +145,7 @@ export class IntervalsFilter {
   overlapping?: IntervalsContainer
   /**
    * Script used to return matching documents.
-   * This script must return a boolean value, `true` or `false`.
+   * This script must return a boolean value: `true` or `false`.
    */
   script?: Script
 }
@@ -171,7 +171,7 @@ export class IntervalsFuzzy {
    */
   term: string
   /**
-   * Indicates whether edits include transpositions of two adjacent characters (for example `ab` to `ba`).
+   * Indicates whether edits include transpositions of two adjacent characters (for example, `ab` to `ba`).
    * @server_default true
    */
   transpositions?: boolean
@@ -303,7 +303,7 @@ export class MatchQuery extends QueryBase {
    */
   fuzzy_rewrite?: MultiTermQueryRewrite
   /**
-   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example `ab` to `ba`).
+   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
    * @server_default true
    */
   fuzzy_transpositions?: boolean
@@ -365,7 +365,7 @@ export class MatchBoolPrefixQuery extends QueryBase {
    */
   fuzzy_rewrite?: MultiTermQueryRewrite
   /**
-   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example `ab` to `ba`).
+   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
    * Can be applied to the term subqueries constructed for all terms but the final term.
    * @server_default true
    */
@@ -481,7 +481,7 @@ export class MultiMatchQuery extends QueryBase {
    */
   fuzzy_rewrite?: MultiTermQueryRewrite
   /**
-   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example `ab` to `ba`).
+   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
    * Can be applied to the term subqueries constructed for all terms but the final term.
    * @server_default true
    */
@@ -539,11 +539,11 @@ export class MultiMatchQuery extends QueryBase {
 
 export enum TextQueryType {
   /**
-   * Finds documents which match any field, but uses the `_score` from the best field.
+   * Finds documents that match any field, but uses the `_score` from the best field.
    */
   best_fields = 0,
   /**
-   * Finds documents which match any field and combines the `_score` from each field.
+   * Finds documents that match any field and combines the `_score` from each field.
    */
   most_fields = 1,
   /**
@@ -593,7 +593,7 @@ export class QueryStringQuery extends QueryBase {
    */
   analyze_wildcard?: boolean
   /**
-   * If true, match phrase queries are automatically created for multi-term synonyms.
+   * If `true`, match phrase queries are automatically created for multi-term synonyms.
    * @server_default true
    */
   auto_generate_synonyms_phrase_query?: boolean
@@ -640,7 +640,7 @@ export class QueryStringQuery extends QueryBase {
    */
   fuzzy_rewrite?: MultiTermQueryRewrite
   /**
-   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example `ab` to `ba`).
+   * If `true`, edits for fuzzy matching include transpositions of two adjacent characters (for example, `ab` to `ba`).
    * @server_default true
    */
   fuzzy_transpositions?: boolean

specification/_types/query_dsl/specialized.ts

@@ -109,22 +109,22 @@ export class MoreLikeThisQuery extends QueryBase {
    */
   like: Like | Like[]
   /**
-   * The maximum document frequency above which the terms will be ignored from the input document.
+   * The maximum document frequency above which the terms are ignored from the input document.
    */
   max_doc_freq?: integer
   /**
-   * The maximum number of query terms that will be selected.
+   * The maximum number of query terms that can be selected.
    * @server_default 25
    */
   max_query_terms?: integer
   /**
-   * The maximum word length above which the terms will be ignored.
+   * The maximum word length above which the terms are ignored.
    * Defaults to unbounded (`0`).
    * @server_default 0
    */
   max_word_length?: integer
   /**
-   * The minimum document frequency below which the terms will be ignored from the input document.
+   * The minimum document frequency below which the terms are ignored from the input document.
    * @server_default 5
    */
   min_doc_freq?: integer
@@ -134,12 +134,12 @@ export class MoreLikeThisQuery extends QueryBase {
    */
   minimum_should_match?: MinimumShouldMatch
   /**
-   * The minimum term frequency below which the terms will be ignored from the input document.
+   * The minimum term frequency below which the terms are ignored from the input document.
    * @server_default 2
    */
   min_term_freq?: integer
   /**
-   * The minimum word length below which the terms will be ignored.
+   * The minimum word length below which the terms are ignored.
    * @server_default 0
    */
   min_word_length?: integer
@@ -150,7 +150,7 @@ export class MoreLikeThisQuery extends QueryBase {
   routing?: Routing
   /**
    * An array of stop words.
-   * Any word in this set is considered "uninteresting" and ignored.
+   * Any word in this set is ignored.
    */
   stop_words?: StopWords
   /**
@@ -200,7 +200,7 @@ export class PercolateQuery extends QueryBase {
    */
   documents?: UserDefinedValue[]
   /**
-   * The field of type percolator that holds the indexed queries.
+   * Field that holds the indexed queries. The field must use the `percolator` mapping type.
    */
   field: Field
   /**
@@ -212,15 +212,15 @@ export class PercolateQuery extends QueryBase {
    */
   index?: IndexName
   /**
-   * The suffix to be used for the `_percolator_document_slot` field in case multiple `percolate` queries have been specified.
+   * The suffix used for the `_percolator_document_slot` field when multiple `percolate` queries are specified.
    */
   name?: string
   /**
-   * Preference to be used to fetch document to percolate.
+   * Preference used to fetch document to percolate.
    */
   preference?: string
   /**
-   * Routing to be used to fetch document to percolate.
+   * Routing used to fetch document to percolate.
    */
   routing?: Routing
   /**