[Groonga-commit] groonga/groonga at f43af5c [master] doc: unify data set name to "example"

Back to archive index

HAYASHI Kentaro null+****@clear*****
Thu Apr 14 16:30:01 JST 2016


HAYASHI Kentaro	2016-04-14 16:30:01 +0900 (Thu, 14 Apr 2016)

  New Revision: f43af5c549d5a1ddba11be5645133aae68db38d4
  https://github.com/groonga/groonga/commit/f43af5c549d5a1ddba11be5645133aae68db38d4

  Message:
    doc: unify data set name to "example"
    
    [groonga-dev,04008]
    
    Reported by Tachikawa Hiroaki. Thanks!!!
    
    TODO: Update execution examples

  Modified files:
    doc/source/reference/suggest/completion.rst
    doc/source/reference/suggest/correction.rst
    doc/source/reference/suggest/suggestion.rst

  Modified: doc/source/reference/suggest/completion.rst (+15 -15)
===================================================================
--- doc/source/reference/suggest/completion.rst    2016-04-14 14:04:23 +0900 (5eb60cb)
+++ doc/source/reference/suggest/completion.rst    2016-04-14 16:30:01 +0900 (a2b3547)
@@ -3,7 +3,7 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. % groonga-suggest-create-dataset /tmp/groonga-databases/completion query
+.. % groonga-suggest-create-dataset /tmp/groonga-databases/completion example
 .. database: completion
 
 Completion
@@ -144,7 +144,7 @@ How to use
 ----------
 
 .. groonga-command
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. load --table event_example --each 'suggest_preparer(_id, type, item, sequence, time, pair_example)'
 .. [
 .. {"sequence": "1", "time": 1312950803.86057, "item": "e"},
 .. {"sequence": "1", "time": 1312950803.96857, "item": "en"},
@@ -162,7 +162,7 @@ For example, here is an command to get completion results by
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/complete/select.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query en
+.. suggest --table item_example --column kana --types complete --frequency_threshold 1 --query en
 
 How it learns
 -------------
@@ -185,7 +185,7 @@ inputs the query with the following sequence:
 Groonga can be learned from the input sequence by the
 following command::
 
-  load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+  load --table event_example --each 'suggest_preparer(_id, type, item, sequence, time, pair_example)'
   [
   {"sequence": "1", "time": 1312950803.86057, "item": "e"},
   {"sequence": "1", "time": 1312950803.96857, "item": "en"},
@@ -205,7 +205,7 @@ Here is an example to register "日本" which means Japan in English:
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/complete/registered-word-japan.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. load --table event_example --each 'suggest_preparer(_id, type, item, sequence, time, pair_example)'
 .. [
 .. {"sequence": "1", "time": 1312950805.86058, "item": "日本", "type": "submit"}
 .. ]
@@ -215,7 +215,7 @@ Here is an example to update reading data to complete "日本":
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/complete/update-rk-data.log
-.. load --table item_query
+.. load --table item_example
 .. [
 .. {"_key":"日本", "kana":["ニホン", "ニッポン"]}
 .. ]
@@ -225,13 +225,13 @@ Then you can complete registered word "日本" by Romaji input -
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/complete/rk-search-nihon.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+.. suggest --table item_example --column kana --types complete --frequency_threshold 1 --query nihon
 
 Without loading above reading data, you can't complete registered word
 "日本" by query - "nihon".
 
 You can register multiple readings for a registered word because
-``kana`` column in ``item_query`` table is defined as a
+``kana`` column in ``item_example`` table is defined as a
 :doc:`/reference/columns/vector`.
 
 This is the reason that you can also complete the registered word "日本"
@@ -239,33 +239,33 @@ by query - "nippon".
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/complete/rk-search-nippon.log
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nippon
+.. suggest --table item_example --column kana --types complete --frequency_threshold 1 --query nippon
 
 This feature is very convenient because you can search registered word
 even though Japanese input method is disabled.
 
 If there are multiple candidates as completed result, you can
 customize priority to set the value of ``boost`` column in
-``item_query`` table.
+``item_example`` table.
 
 Here is an example to customize priority for prefix RK search:
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/complete/registered-word-japanese.log
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. load --table event_example --each 'suggest_preparer(_id, type, item, sequence, time, pair_example)'
 .. [
 .. {"sequence": "1", "time": 1312950805.86059, "item": "日本語", "type": "submit"}
 .. {"sequence": "1", "time": 1312950805.86060, "item": "日本人", "type": "submit"}
 .. ]
-.. load --table item_query
+.. load --table item_example
 .. [
 .. {"_key":"日本語", "kana":"ニホンゴ"}
 .. {"_key":"日本人", "kana":"ニホンジン"}
 .. ]
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
-.. load --table item_query
+.. suggest --table item_example --column kana --types complete --frequency_threshold 1 --query nihon
+.. load --table item_example
 .. [
 .. {"_key":"日本人", "boost": 100},
 .. ]
-.. suggest --table item_query --column kana --types complete --frequency_threshold 1 --query nihon
+.. suggest --table item_example --column kana --types complete --frequency_threshold 1 --query nihon
 

  Modified: doc/source/reference/suggest/correction.rst (+4 -4)
===================================================================
--- doc/source/reference/suggest/correction.rst    2016-04-14 14:04:23 +0900 (c2275b7)
+++ doc/source/reference/suggest/correction.rst    2016-04-14 16:30:01 +0900 (fd8b5ef)
@@ -3,7 +3,7 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. % groonga-suggest-create-dataset /tmp/groonga-databases/correction query
+.. % groonga-suggest-create-dataset /tmp/groonga-databases/correction example
 .. database: correction
 
 Correction
@@ -89,7 +89,7 @@ How to use
 ----------
 
 .. groonga-command
-.. load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+.. load --table event_example --each 'suggest_preparer(_id, type, item, sequence, time, pair_example)'
 .. [
 .. {"sequence": "1", "time": 1312950803.86057, "item": "s"},
 .. {"sequence": "1", "time": 1312950803.96857, "item": "sa"},
@@ -109,7 +109,7 @@ For example, here is an command to get correction results by
 
 .. groonga-command
 .. include:: ../../example/reference/suggest/correction/select.log
-.. suggest --table item_query --column kana --types correction --frequency_threshold 1 --query saerch
+.. suggest --table item_example --column kana --types correction --frequency_threshold 1 --query saerch
 
 How it learns
 -------------
@@ -134,7 +134,7 @@ user inputs the query with the following sequence:
 Groonga can be learned from the input sequence by the
 following command::
 
-  load --table event_query --each 'suggest_preparer(_id, type, item, sequence, time, pair_query)'
+  load --table event_example --each 'suggest_preparer(_id, type, item, sequence, time, pair_example)'
   [
   {"sequence": "1", "time": 1312950803.86057, "item": "s"},
   {"sequence": "1", "time": 1312950803.96857, "item": "sa"},

  Modified: doc/source/reference/suggest/suggestion.rst (+1 -1)
===================================================================
--- doc/source/reference/suggest/suggestion.rst    2016-04-14 14:04:23 +0900 (e39bce6)
+++ doc/source/reference/suggest/suggestion.rst    2016-04-14 16:30:01 +0900 (f8e435f)
@@ -3,7 +3,7 @@
 .. highlightlang:: none
 
 .. groonga-command
-.. % groonga-suggest-create-dataset /tmp/groonga-databases/suggestion query
+.. % groonga-suggest-create-dataset /tmp/groonga-databases/suggestion example
 .. database: suggestion
 
 Suggestion
-------------- next part --------------
HTML����������������������������...
Télécharger 



More information about the Groonga-commit mailing list
Back to archive index