Skip to content

Commit 720dd61

Browse files
authored
Correct grammar on MatchQuery CutoffFrequency (#4692)
This commit fixes the documentation for MatchQuery. Replace "can skips" with "can skip" and remove invalid characters.
1 parent 6e6be17 commit 720dd61

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

src/Nest/QueryDsl/Abstractions/Container/QueryContainerDescriptor.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public QueryContainer Terms(Func<TermsQueryDescriptor<T>, ITermsQuery> selector)
7676

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

162162
/// <summary>
163-
/// More like this query find documents that are like provided text by running it against one or more fields.
163+
/// More like this query find documents that are like the provided text by running it against one or more fields.
164164
/// </summary>
165165
public QueryContainer MoreLikeThis(Func<MoreLikeThisQueryDescriptor<T>, IMoreLikeThisQuery> selector) =>
166166
WrapInContainer(selector, (query, container) => container.MoreLikeThis = query);

src/Nest/QueryDsl/FullText/Match/MatchQuery.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public interface IMatchQuery : IFieldNameQuery
3232
/// or all of the low frequency terms in the case of an <see cref="Nest.Operator.And" /> match.
3333
/// </summary>
3434
[DataMember(Name = "cutoff_frequency")]
35-
[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.")]
35+
[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.")]
3636
double? CutoffFrequency { get; set; }
3737

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

120120
/// <inheritdoc />
121-
[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.")]
121+
[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.")]
122122
public double? CutoffFrequency { get; set; }
123123

124124
/// <inheritdoc />
@@ -168,7 +168,7 @@ public class MatchQueryDescriptor<T>
168168
protected virtual string MatchQueryType => null;
169169
string IMatchQuery.Analyzer { get; set; }
170170
bool? IMatchQuery.AutoGenerateSynonymsPhraseQuery { get; set; }
171-
[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.")]
171+
[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.")]
172172
double? IMatchQuery.CutoffFrequency { get; set; }
173173
IFuzziness IMatchQuery.Fuzziness { get; set; }
174174
MultiTermQueryRewrite IMatchQuery.FuzzyRewrite { get; set; }
@@ -198,7 +198,7 @@ public MatchQueryDescriptor<T> FuzzyTranspositions(bool? fuzzyTranspositions = t
198198
Assign(fuzzyTranspositions, (a, v) => a.FuzzyTranspositions = v);
199199

200200
/// <inheritdoc cref="IMatchQuery.CutoffFrequency" />
201-
[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.")]
201+
[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.")]
202202
public MatchQueryDescriptor<T> CutoffFrequency(double? cutoffFrequency) => Assign(cutoffFrequency, (a, v) => a.CutoffFrequency = v);
203203

204204
/// <inheritdoc cref="IMatchQuery.FuzzyRewrite" />

0 commit comments

Comments
 (0)