Skip to content

[DOCS] Reformats interval query#45350

Merged
jrodewig merged 4 commits intomasterfrom
intervals-query-reformat
Aug 9, 2019
Merged

[DOCS] Reformats interval query#45350
jrodewig merged 4 commits intomasterfrom
intervals-query-reformat

Conversation

@jrodewig
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig commented Aug 8, 2019

Updates the intervals query to use the new query format.

This creates separate sections for the example request, parameters, and notes. It also makes a few changes:

  • Changes future to present tense where possible.
  • Uses a single space between sentences

This is part of #40977, an effort to standardize documentation for query types.

Preview

http://elasticsearch_45350.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/query-dsl-intervals-query.html

@jrodewig jrodewig added >docs General docs changes :Search/Search Search-related issues that do not fall into other categories v8.0.0 v7.0.2 v7.1.2 v7.4.0 v7.3.1 v7.2.2 labels Aug 8, 2019
@jrodewig jrodewig requested a review from romseygeek August 8, 2019 18:37
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-search

@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs

@jrodewig jrodewig force-pushed the intervals-query-reformat branch from 7cdb0f7 to 979319c Compare August 8, 2019 18:39
Copy link
Copy Markdown
Contributor

@romseygeek romseygeek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jrodewig - a couple of small nits but LGTM overall

{
"match" : {
"query" : "my favourite food",
"query" : "my favorite food",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two nations separated by the same language :)

(Required, array of rule objects) Field you wish to search.

The value of this parameter is an array of rule objects used to match documents
based on matching terms, order, and proximity.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a single rule object, rather than an array

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with 5f231e7

The `prefix` rule matches terms that start with a specified set of characters.
This prefix can expand to match at most 128 terms. If the prefix matches more than
128 terms, {es} returns an error. You can use the
<<index-prefixes,`index-prefixes`>> option to avoid this limit.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/option to avoid/option on the field mapping to avoid/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with 553a686.

matches produced by the rules must all appear immediately next to each other.
+
--
(Optional, integer) Maximum number of positions between the matching terms.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/terms/intervals produced by the rules/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed with fe1a4a6.

@jrodewig
Copy link
Copy Markdown
Contributor Author

jrodewig commented Aug 9, 2019

Thanks for the review @romseygeek!

@jrodewig jrodewig merged commit af70fb9 into master Aug 9, 2019
@jrodewig jrodewig deleted the intervals-query-reformat branch August 9, 2019 12:53
jrodewig added a commit that referenced this pull request Aug 9, 2019
jrodewig added a commit that referenced this pull request Aug 9, 2019
jrodewig added a commit that referenced this pull request Aug 9, 2019
jrodewig added a commit that referenced this pull request Aug 9, 2019
jrodewig added a commit that referenced this pull request Aug 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :Search/Search Search-related issues that do not fall into other categories v7.0.2 v7.1.2 v7.2.2 v7.3.1 v7.4.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants