Skip to content

Commit

Permalink
Correct grammar on MatchQuery CutoffFrequency (#4692)
Browse files Browse the repository at this point in the history
This commit fixes the documentation for MatchQuery.
Replace "can skips" with "can skip" and remove invalid
characters.
  • Loading branch information
DanAtkinson authored Jun 2, 2020
1 parent 6e6be17 commit 720dd61
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public QueryContainer Terms(Func<TermsQueryDescriptor<T>, ITermsQuery> selector)

/// <summary>
/// A fuzzy based query that uses similarity based on Levenshtein (edit distance) algorithm.
/// Warning: this query is not very scalable with its default prefix length of 0 � in this case,
/// Warning: this query is not very scalable with its default prefix length of 0. In this case,
/// every term will be enumerated and cause an edit score calculation or max_expansions is not set.
/// </summary>
public QueryContainer Fuzzy(Func<FuzzyQueryDescriptor<T>, IFuzzyQuery> selector) =>
Expand Down Expand Up @@ -160,7 +160,7 @@ public QueryContainer TermRange(Func<TermRangeQueryDescriptor<T>, ITermRangeQuer
WrapInContainer(selector, (query, container) => container.Range = query);

/// <summary>
/// More like this query find documents that are like provided text by running it against one or more fields.
/// More like this query find documents that are like the provided text by running it against one or more fields.
/// </summary>
public QueryContainer MoreLikeThis(Func<MoreLikeThisQueryDescriptor<T>, IMoreLikeThisQuery> selector) =>
WrapInContainer(selector, (query, container) => container.MoreLikeThis = query);
Expand Down
8 changes: 4 additions & 4 deletions src/Nest/QueryDsl/FullText/Match/MatchQuery.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ public interface IMatchQuery : IFieldNameQuery
/// or all of the low frequency terms in the case of an <see cref="Nest.Operator.And" /> match.
/// </summary>
[DataMember(Name = "cutoff_frequency")]
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skips blocks of documents efficiently if the total number of hits is not tracked.")]
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skip blocks of documents efficiently if the total number of hits is not tracked.")]
double? CutoffFrequency { get; set; }

/// <summary>
Expand Down Expand Up @@ -118,7 +118,7 @@ public class MatchQuery : FieldNameQueryBase, IMatchQuery
public bool? AutoGenerateSynonymsPhraseQuery { get; set; }

/// <inheritdoc />
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skips blocks of documents efficiently if the total number of hits is not tracked.")]
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skip blocks of documents efficiently if the total number of hits is not tracked.")]
public double? CutoffFrequency { get; set; }

/// <inheritdoc />
Expand Down Expand Up @@ -168,7 +168,7 @@ public class MatchQueryDescriptor<T>
protected virtual string MatchQueryType => null;
string IMatchQuery.Analyzer { get; set; }
bool? IMatchQuery.AutoGenerateSynonymsPhraseQuery { get; set; }
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skips blocks of documents efficiently if the total number of hits is not tracked.")]
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skip blocks of documents efficiently if the total number of hits is not tracked.")]
double? IMatchQuery.CutoffFrequency { get; set; }
IFuzziness IMatchQuery.Fuzziness { get; set; }
MultiTermQueryRewrite IMatchQuery.FuzzyRewrite { get; set; }
Expand Down Expand Up @@ -198,7 +198,7 @@ public MatchQueryDescriptor<T> FuzzyTranspositions(bool? fuzzyTranspositions = t
Assign(fuzzyTranspositions, (a, v) => a.FuzzyTranspositions = v);

/// <inheritdoc cref="IMatchQuery.CutoffFrequency" />
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skips blocks of documents efficiently if the total number of hits is not tracked.")]
[Obsolete("Deprecated in 7.3.0. This option can be omitted since MatchQuery can skip blocks of documents efficiently if the total number of hits is not tracked.")]
public MatchQueryDescriptor<T> CutoffFrequency(double? cutoffFrequency) => Assign(cutoffFrequency, (a, v) => a.CutoffFrequency = v);

/// <inheritdoc cref="IMatchQuery.FuzzyRewrite" />
Expand Down

0 comments on commit 720dd61

Please sign in to comment.