[DOCS] Update parameter format #44703
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Pinging @elastic/es-docs |
|
Pinging @elastic/es-search |
|
retest this please |
jtibshirani
approved these changes
Jul 30, 2019
| + | ||
| -- | ||
| Query used to decrease the <<query-filter-context, relevance score>> of matching | ||
| documents. | ||
| (Required, query object) Query used to decrease the <<query-filter-context, |
There was a problem hiding this comment.
I don't mean to nitpick too much, but I wonder if 'Required' and 'Optional' should be lowercase to match the types like 'query object' and 'string'?
There was a problem hiding this comment.
I'm going to leave this capitalized for now so it's consistent with the Elastic API Reference template. I can easily change this later if we decide to change the capitalization in the template.
jrodewig
added a commit
that referenced
this pull request
Jul 31, 2019
jrodewig
added a commit
that referenced
this pull request
Jul 31, 2019
jrodewig
added a commit
that referenced
this pull request
Jul 31, 2019
jrodewig
added a commit
that referenced
this pull request
Jul 31, 2019
jrodewig
added a commit
that referenced
this pull request
Jul 31, 2019
jrodewig
added a commit
that referenced
this pull request
Jul 31, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
elastic/docs#982 updated the API reference template to change the location of the Required/Optional parameter qualifier.
This updates the parameter format for any query documentation updated as part of #40977 to match the template. This PR includes no other substantive changes.