[Groonga-commit] groonga/groonga at 7b655db [master] doc: use sort_keys in reference

Back to archive index

Susumu Yata null+****@clear*****
Fri Jan 12 15:41:38 JST 2018


Susumu Yata	2018-01-12 15:41:38 +0900 (Fri, 12 Jan 2018)

  New Revision: 7b655db64d7a4bc415e3e4d59ba631360117cd04
  https://github.com/groonga/groonga/commit/7b655db64d7a4bc415e3e4d59ba631360117cd04

  Message:
    doc: use sort_keys in reference
    
    GitHub: #604

  Modified files:
    doc/source/reference/functions/in_values.rst
    doc/source/reference/functions/query.rst
    doc/source/reference/scorer.rst
    doc/source/reference/scorers/scorer_tf_at_most.rst
    doc/source/reference/scorers/scorer_tf_idf.rst

  Modified: doc/source/reference/functions/in_values.rst (+1 -1)
===================================================================
--- doc/source/reference/functions/in_values.rst    2018-01-12 12:45:15 +0900 (3b330c9e8)
+++ doc/source/reference/functions/in_values.rst    2018-01-12 15:41:38 +0900 (2efe8c988)
@@ -55,7 +55,7 @@ Here is the simple usage of ``in_values`` function which selects the records - t
 
 .. groonga-command
 .. include:: ../../example/reference/functions/in_values/usage_only.log
-.. select Memos --output_columns _key,tag --filter 'in_values(tag, "groonga", "mroonga", "droonga")' --sortby _id
+.. select Memos --output_columns _key,tag --filter 'in_values(tag, "groonga", "mroonga", "droonga")' --sort_keys _id
 
 When executing the above query, you can get the records except "rroonga" because "rroonga" is not specified as value in ``in_values``.
 

  Modified: doc/source/reference/functions/query.rst (+2 -2)
===================================================================
--- doc/source/reference/functions/query.rst    2018-01-12 12:45:15 +0900 (8e8f255c4)
+++ doc/source/reference/functions/query.rst    2018-01-12 15:41:38 +0900 (e8a82adeb)
@@ -96,7 +96,7 @@ Here are the contrasting examples with/without ``query``.
 
 .. groonga-command
 .. include:: ../../example/reference/functions/query/usage_without_query.log
-.. select Users --output_columns name,memo,_score --match_columns "memo * 10" --query "memo:@groonga OR memo:@mroonga OR memo:@user" --sortby -_score
+.. select Users --output_columns name,memo,_score --match_columns "memo * 10" --query "memo:@groonga OR memo:@mroonga OR memo:@user" --sort_keys -_score
 
 In this case, the all keywords ``groonga``, ``mroonga`` and ``user``
 use the default weight. You can't pass different weight value to each
@@ -104,7 +104,7 @@ keyword in this way.
 
 .. groonga-command
 .. include:: ../../example/reference/functions/query/usage_with_query.log
-.. select Users --output_columns name,memo,_score --filter 'query("memo * 10", "groonga") || query("memo * 20", "mroonga") || query("memo * 1", "user")' --sortby -_score
+.. select Users --output_columns name,memo,_score --filter 'query("memo * 10", "groonga") || query("memo * 20", "mroonga") || query("memo * 1", "user")' --sort_keys -_score
 
 On the other hand, by specifying multiple ``query``, the keywords
 ``groonga``, ``mroonga`` and ``user`` use different weight.

  Modified: doc/source/reference/scorer.rst (+5 -5)
===================================================================
--- doc/source/reference/scorer.rst    2018-01-12 12:45:15 +0900 (9c685cef4)
+++ doc/source/reference/scorer.rst    2018-01-12 15:41:38 +0900 (18cbe0c12)
@@ -138,7 +138,7 @@ Here is a simplest example:
 ..   --match_columns "scorer_tf_idf(content)" \
 ..   --query "Groonga" \
 ..   --output_columns "content, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 ``Groonga! Groonga! Groonga! Groonga is very fast!`` contains 4
 ``Groonga``. If you use TF based scorer that is the default scorer,
@@ -153,7 +153,7 @@ Here is an example that uses weight:
 ..   --match_columns "scorer_tf_idf(content) * 10" \
 ..   --query "Groonga" \
 ..   --output_columns "content, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 ``Groonga! Groonga! Groonga! Groonga is very fast!`` has ``22`` as
 ``_score``. It had ``2`` as ``_score`` in the previous example that
@@ -169,7 +169,7 @@ one argument. You can limit TF score by the scorer.
 ..   --match_columns "scorer_tf_at_most(content, 2.0)" \
 ..   --query "Groonga" \
 ..   --output_columns "content, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 ``Groonga! Groonga! Groonga! Groonga is very fast!`` contains 4
 ``Groonga``. If you use normal TF based scorer that is the default
@@ -185,7 +185,7 @@ Here is an example that uses multiple scorers:
 ..   --match_columns "scorer_tf_idf(title) || scorer_tf_at_most(content, 2.0)" \
 ..   --query "Groonga" \
 ..   --output_columns "title, content, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 The ``--match_columns`` uses ``scorer_tf_idf(title)`` and
 ``scorer_tf_at_most(content, 2.0)``. ``_score`` value is sum of them.
@@ -200,7 +200,7 @@ a match column:
 ..   --match_columns "title || scorer_tf_at_most(content, 2.0)" \
 ..   --query "Groonga" \
 ..   --output_columns "title, content, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 The ``--match_columns`` uses the default scorer (TF) for ``title`` and
 :doc:`/reference/scorers/scorer_tf_at_most` for

  Modified: doc/source/reference/scorers/scorer_tf_at_most.rst (+1 -1)
===================================================================
--- doc/source/reference/scorers/scorer_tf_at_most.rst    2018-01-12 12:45:15 +0900 (8d52ca1f8)
+++ doc/source/reference/scorers/scorer_tf_at_most.rst    2018-01-12 15:41:38 +0900 (1aa233d98)
@@ -86,7 +86,7 @@ the following:
 ..   --match_columns "scorer_tf_at_most(message, 3.0)" \
 ..   --query "Notice" \
 ..   --output_columns "message, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 If a document has three or more ``Notice`` terms, its score is ``3``.
 Because the ``select`` specify ``3.0`` as the max score.

  Modified: doc/source/reference/scorers/scorer_tf_idf.rst (+1 -1)
===================================================================
--- doc/source/reference/scorers/scorer_tf_idf.rst    2018-01-12 12:45:15 +0900 (f3d04871a)
+++ doc/source/reference/scorers/scorer_tf_idf.rst    2018-01-12 15:41:38 +0900 (ef6d04d72)
@@ -105,7 +105,7 @@ following:
 ..   --match_columns "scorer_tf_idf(message)" \
 ..   --query "Error OR Info" \
 ..   --output_columns "message, _score" \
-..   --sortby "-_score"
+..   --sort_keys "-_score"
 
 Both the score of ``Info Info Info`` and the score of ``Error`` are
 ``2`` even ``Info Info Info`` includes three ``Info`` terms. Because
-------------- next part --------------
HTML����������������������������...
URL: https://lists.osdn.me/mailman/archives/groonga-commit/attachments/20180112/902b6938/attachment-0001.htm 



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