[DOCS] Updates terms in anomaly detection job APIs #44839
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/ml-core |
6 tasks
droberts195
approved these changes
Jul 25, 2019
|
|
||
| ["source","java",subs="attributes,callouts,macros"] | ||
| --------------------------------------------------- | ||
| include-tagged::{doc-tests-file}[{api}-response] | ||
| --------------------------------------------------- | ||
| <1> whether was job deletion was acknowledged or not; will be `null` when set not to wait for completion | ||
| <2> the id of the job deletion task; will be `null` when set to wait for completion | ||
| <1> whether was job deletion was acknowledged or not; will be `null` when set |
There was a problem hiding this comment.
It's not a problem introduced by this PR, but there's a spurious "was" between "whether" and "job".
Also most of these callout notes begin with capital letters but <1> and <2> here don't.
And finally <2> contains "id" in lowercase, and elsewhere you've been changing these to "ID" in uppercase.
Since the PR is green feel free to merge as-is and leave these typos for a future PR if you prefer.
There was a problem hiding this comment.
Thanks, @droberts195 I've put those fixes in #44865
lcawl
added a commit
that referenced
this pull request
Jul 25, 2019
lcawl
added a commit
that referenced
this pull request
Jul 25, 2019
lcawl
added a commit
that referenced
this pull request
Jul 25, 2019
jkakavas
pushed 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.
Related to elastic/stack-docs#237
This PR updates the terminology in the Java REST Client and Elasticsearch Reference documentation such that it uses appropriate "anomaly detection job" terminology in the create, delete, open, and close job APIs.
NOTE: The Elasticsearch Reference has a separate "Machine learning anomaly detection APIs" section whereas the Java REST Client still just has a "Machine learning APIs" section. This might need to be rectified in the future. For now, I've altered the navigation titles in each book to reflect that difference.