Browse Source

[DOCS] Clarify 'type' parameter meaning for custom analyzer (#34012)

This pull request improves the docs on the meaning of type parameter on the custom 
analyzer doc page. 

Closes #33456
Nikolay Vasiliev 7 years ago
parent
commit
16956a1a05
1 changed files with 6 additions and 1 deletions
  1. 6 1
      docs/reference/analysis/analyzers/custom-analyzer.asciidoc

+ 6 - 1
docs/reference/analysis/analyzers/custom-analyzer.asciidoc

@@ -59,7 +59,7 @@ PUT my_index
     "analysis": {
       "analyzer": {
         "my_custom_analyzer": {
-          "type":      "custom",
+          "type":      "custom", <1>
           "tokenizer": "standard",
           "char_filter": [
             "html_strip"
@@ -82,6 +82,11 @@ POST my_index/_analyze
 --------------------------------
 // CONSOLE
 
+<1> Setting `type` to `custom` tells Elasticsearch that we are defining a custom analyzer.
+    Compare this to how <<configuring-analyzers,built-in analyzers can be configured>>:
+    `type` will be set to the name of the built-in analyzer, like
+    <<analysis-standard-analyzer,`standard`>> or <<analysis-simple-analyzer,`simple`>>.
+
 /////////////////////
 
 [source,js]