HAYASHI Kentaro
null+****@clear*****
Fri Feb 20 00:32:33 JST 2015
HAYASHI Kentaro 2015-02-20 00:32:33 +0900 (Fri, 20 Feb 2015) New Revision: de04628f2a1faf3ad80717976a6f2e0eb3972d25 https://github.com/groonga/groonga/commit/de04628f2a1faf3ad80717976a6f2e0eb3972d25 Message: Use "Specifies ..." to describe details of parameters It is natural for parameter name and description in reference manual. Modified files: doc/source/reference/commands/cache_limit.rst doc/source/reference/commands/column_list.rst doc/source/reference/commands/column_rename.rst doc/source/reference/commands/delete.rst doc/source/reference/commands/load.rst doc/source/reference/commands/lock_clear.rst doc/source/reference/commands/logical_count.rst doc/source/reference/commands/normalize.rst doc/source/reference/commands/request_cancel.rst doc/source/reference/commands/ruby_eval.rst doc/source/reference/commands/ruby_load.rst doc/source/reference/commands/select.rst doc/source/reference/commands/suggest.rst doc/source/reference/commands/table_create.rst doc/source/reference/commands/table_tokenize.rst doc/source/reference/commands/tokenize.rst doc/source/reference/commands/truncate.rst doc/source/reference/functions/between.rst doc/source/reference/functions/geo_distance.rst doc/source/reference/functions/highlight_full.rst doc/source/reference/functions/highlight_html.rst doc/source/reference/functions/html_untag.rst doc/source/reference/functions/in_values.rst doc/source/reference/functions/query.rst doc/source/reference/functions/sub_filter.rst Modified: doc/source/reference/commands/cache_limit.rst (+1 -1) =================================================================== --- doc/source/reference/commands/cache_limit.rst 2015-02-19 18:40:38 +0900 (b7353d0) +++ doc/source/reference/commands/cache_limit.rst 2015-02-20 00:32:33 +0900 (0ab95a6) @@ -59,7 +59,7 @@ This section describes all parameters. ``max`` """"""" -It specifies the max number of query cache entries as a number. +Specifies the max number of query cache entries as a number. If ``max`` parameter isn't specified, the current max number of query cache entries isn't changed. ``cache_limit`` just returns the current Modified: doc/source/reference/commands/column_list.rst (+1 -1) =================================================================== --- doc/source/reference/commands/column_list.rst 2015-02-19 18:40:38 +0900 (f144b4b) +++ doc/source/reference/commands/column_list.rst 2015-02-20 00:32:33 +0900 (7b9cee7) @@ -46,7 +46,7 @@ All parameters are required. ``table`` """"""""" -It specifies the name of table to be listed columns. +Specifies the name of table to be listed columns. Return value ------------ Modified: doc/source/reference/commands/column_rename.rst (+3 -3) =================================================================== --- doc/source/reference/commands/column_rename.rst 2015-02-19 18:40:38 +0900 (2b90ebb) +++ doc/source/reference/commands/column_rename.rst 2015-02-20 00:32:33 +0900 (81ebd97) @@ -69,17 +69,17 @@ All parameters are required. ``table`` """"""""" -It specifies the name of table that has the column to be renamed. +Specifies the name of table that has the column to be renamed. ``name`` """""""" -It specifies the column name to be renamed. +Specifies the column name to be renamed. ``new_name`` """""""""""" -It specifies the new column name. +Specifies the new column name. Return value Modified: doc/source/reference/commands/delete.rst (+4 -4) =================================================================== --- doc/source/reference/commands/delete.rst 2015-02-19 18:40:38 +0900 (b7467dc) +++ doc/source/reference/commands/delete.rst 2015-02-20 00:32:33 +0900 (7a79349) @@ -83,20 +83,20 @@ Parameters ``table`` - It specifies the name of table to delete the records. + Specifies the name of table to delete the records. ``key`` - It specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored. + Specifies the key of record to delete. If you use the table with TABLE_NO_KEY, the key is just ignored. (Use ``id`` parameter in such a case) ``id`` - It specifies the id of record to delete. If you specify ``id`` parameter, you must not specify ``key`` parameter. + Specifies the id of record to delete. If you specify ``id`` parameter, you must not specify ``key`` parameter. ``filter`` - It specifies the expression of grn_expr to identify the record. If you specify ``filter`` parameter, + Specifies the expression of grn_expr to identify the record. If you specify ``filter`` parameter, you must not specify ``key`` and ``id`` parameter. Return value Modified: doc/source/reference/commands/load.rst (+5 -5) =================================================================== --- doc/source/reference/commands/load.rst 2015-02-19 18:40:38 +0900 (a8d33db) +++ doc/source/reference/commands/load.rst 2015-02-20 00:32:33 +0900 (f93a414) @@ -27,7 +27,7 @@ This section describes all parameters. ``values`` - It specifies values loaded to records. + Specifies values loaded to records. Values should satisfy ``input_type`` format. If you specify "json" as ``input_type``, you can choose a format from below: @@ -48,15 +48,15 @@ This section describes all parameters. ``table`` - It specifies a table name you want to add records. + Specifies a table name you want to add records. ``columns`` - It specifies column names in added records with comma separations. + Specifies column names in added records with comma separations. ``ifexists`` - It specifies executed ``grn_expr`` string when the same primary key + Specifies executed ``grn_expr`` string when the same primary key as added records already exists in your table. If ``ifexists`` specifies ``grn_expr`` string (default: true) and its value is true, values in other (all columns excluding ``_key`` @@ -64,7 +64,7 @@ This section describes all parameters. ``input_type`` - It specifies an input format for ``values``. It supports JSON only. + Specifies an input format for ``values``. It supports JSON only. Usage ----- Modified: doc/source/reference/commands/lock_clear.rst (+1 -1) =================================================================== --- doc/source/reference/commands/lock_clear.rst 2015-02-19 18:40:38 +0900 (3cc7d34) +++ doc/source/reference/commands/lock_clear.rst 2015-02-20 00:32:33 +0900 (ed0af06) @@ -69,7 +69,7 @@ This section describes all parameters. ``target_name`` """"""""""""""" -It specifies the name of table or column. +Specifies the name of table or column. If you don't specify it, database is used for the target object. Modified: doc/source/reference/commands/logical_count.rst (+6 -6) =================================================================== --- doc/source/reference/commands/logical_count.rst 2015-02-19 18:40:38 +0900 (4618313) +++ doc/source/reference/commands/logical_count.rst 2015-02-20 00:32:33 +0900 (888f0bb) @@ -107,34 +107,34 @@ Parameters ``logical_table`` """"""""""""""""" -It specifies logical table name. It means table name without "_YYYYMMDD" postfix. +Specifies logical table name. It means table name without "_YYYYMMDD" postfix. If you use actual table such as "Logs_20150203", "Logs_20150203" and so on, logical table name is "Logs". ``shard_key`` """"""""""""" -It specifies column name which is treated as shared key in each parted table. +Specifies column name which is treated as shared key in each parted table. ``min`` """"""" -It specifies the min value of ``shard_key`` +Specifies the min value of ``shard_key`` ``min_border`` """""""""""""" -It specifies whether the min value of borderline must be include or not. +Specifies whether the min value of borderline must be include or not. Specify ``include`` or ``exclude`` as the value of this parameter. ``max`` """"""" -It specifies the max value of ``shard_key``. +Specifies the max value of ``shard_key``. ``max_border`` """""""""""""" -It specifies whether the max value of borderline must be include or not. +Specifies whether the max value of borderline must be include or not. Specify ``include`` or ``exclude`` as the value of this parameter. ``filter`` Modified: doc/source/reference/commands/normalize.rst (+3 -3) =================================================================== --- doc/source/reference/commands/normalize.rst 2015-02-19 18:40:38 +0900 (9fc738a) +++ doc/source/reference/commands/normalize.rst 2015-02-20 00:32:33 +0900 (7c8a473) @@ -55,7 +55,7 @@ There are required parameters, ``normalizer`` and ``string``. ``normalizer`` """""""""""""" -It specifies the normalizer name. ``normalize`` command uses the +Specifies the normalizer name. ``normalize`` command uses the normalizer that is named ``normalizer``. See :doc:`/reference/normalizers` about built-in normalizers. @@ -72,7 +72,7 @@ MySQL compatible normalizer by registering `groonga-normalizer-mysql ``string`` """""""""" -It specifies any string which you want to normalize. +Specifies any string which you want to normalize. If you want to include spaces in ``string``, you need to quote ``string`` by single quotation (``'``) or double quotation (``"``). @@ -89,7 +89,7 @@ There are optional parameters. ``flags`` """"""""" -It specifies a normalization customize options. You can specify +Specifies a normalization customize options. You can specify multiple options separated by "``|``". For example, ``REMOVE_BLANK|WITH_TYPES``. Modified: doc/source/reference/commands/request_cancel.rst (+1 -1) =================================================================== --- doc/source/reference/commands/request_cancel.rst 2015-02-19 18:40:38 +0900 (45b5a82) +++ doc/source/reference/commands/request_cancel.rst 2015-02-20 00:32:33 +0900 (2501dff) @@ -97,7 +97,7 @@ There is required parameter, ``id``. ``id`` """""" -It specifies the ID for the target request. +Specifies the ID for the target request. Return value ------------ Modified: doc/source/reference/commands/ruby_eval.rst (+1 -1) =================================================================== --- doc/source/reference/commands/ruby_eval.rst 2015-02-19 18:40:38 +0900 (60cb4cb) +++ doc/source/reference/commands/ruby_eval.rst 2015-02-20 00:32:33 +0900 (1e81ba3) @@ -45,7 +45,7 @@ This section describes all parameters. ``script`` """""""""" -It specifies the Ruby script which you want to evaluate. +Specifies the Ruby script which you want to evaluate. Return value ------------ Modified: doc/source/reference/commands/ruby_load.rst (+1 -1) =================================================================== --- doc/source/reference/commands/ruby_load.rst 2015-02-19 18:40:38 +0900 (fe10e04) +++ doc/source/reference/commands/ruby_load.rst 2015-02-20 00:32:33 +0900 (a31773d) @@ -45,7 +45,7 @@ This section describes all parameters. ``path`` """""""" -It specifies the Ruby script path which you want to load. +Specifies the Ruby script path which you want to load. Return value ------------ Modified: doc/source/reference/commands/select.rst (+17 -17) =================================================================== --- doc/source/reference/commands/select.rst 2015-02-19 18:40:38 +0900 (69daea8) +++ doc/source/reference/commands/select.rst 2015-02-20 00:32:33 +0900 (5899c85) @@ -297,7 +297,7 @@ There is a required parameter, ``table``. ``table`` """"""""" -It specifies a table to be searched. ``table`` must be specified. +Specifies a table to be searched. ``table`` must be specified. If nonexistent table is specified, an error is returned. @@ -322,7 +322,7 @@ and ``filter`` aren't specified, all records are selected. ``match_columns`` """"""""""""""""" -It specifies the default target column for fulltext search by +Specifies the default target column for fulltext search by ``query`` parameter value. A target column for fulltext search can be specified in ``query`` parameter. The difference between ``match_columns`` and ``query`` is whether weight is supported or @@ -391,7 +391,7 @@ of blog entry is more important rather thatn content of blog entry. ``query`` """"""""" -It specifies the query text. Normally, it is used for fulltext search +Specifies the query text. Normally, it is used for fulltext search with ``match_columns`` parameter. ``query`` parameter is designed for a fulltext search form in a Web page. A query text should be formatted in :doc:`/reference/grn_expr/query_syntax`. The syntax is similar to common search @@ -452,7 +452,7 @@ See :doc:`/reference/grn_expr/query_syntax` for other operations. ``filter`` """""""""" -It specifies the filter text. Normally, it is used for complex search +Specifies the filter text. Normally, it is used for complex search conditions. ``filter`` can be used with ``query`` parameter. If both ``filter`` and ``query`` are specified, there are conbined with logical and. It means that matched records should be matched against @@ -493,7 +493,7 @@ Advanced search parameters ``match_escalation_threshold`` """""""""""""""""""""""""""""" -It specifies threshold to determine whether search storategy +Specifies threshold to determine whether search storategy escalation is used or not. The threshold is compared against the number of matched records. If the number of matched records is equal to or less than the threshold, the search storategy escalation is @@ -740,7 +740,7 @@ Output related parameters ``output_columns`` """""""""""""""""" -It specifies output columns separated by ``,``. +Specifies output columns separated by ``,``. Here is a simple ``output_columns`` usage example. @@ -772,7 +772,7 @@ values except ``_score`` are outputted. ``sortby`` """""""""" -It specifies sort keys separated by ``,``. Each sort key is column +Specifies sort keys separated by ``,``. Each sort key is column name. Here is a simple ``sortby`` usage example. @@ -815,7 +815,7 @@ it's just ignored but get a warning in log file. ``offset`` """""""""" -It specifies offset to determine output records range. Offset is +Specifies offset to determine output records range. Offset is zero-based. ``--offset 1`` means output range is started from the 2nd record. @@ -843,7 +843,7 @@ The default value is ``0``. ``limit`` """"""""" -It specifies the max number of output records. If the number of +Specifies the max number of output records. If the number of matched records is less than ``limit``, all records are outputted. Here is a simple ``limit`` usage example. @@ -890,7 +890,7 @@ drilldown related parameters are described in another section. ``drilldown`` """"""""""""" -It specifies keys for grouping separated by ``,``. +Specifies keys for grouping separated by ``,``. Matched records by specified search conditions are grouped by each key. If you specify no search condition, all records are grouped by @@ -954,7 +954,7 @@ The ``select`` command outputs the following information: ``drilldown_sortby`` """""""""""""""""""" -It specifies sort keys for drilldown outputs separated by ``,``. Each +Specifies sort keys for drilldown outputs separated by ``,``. Each sort key is column name. You can refer the number of grouped records by ``_nsubrecs`` @@ -996,7 +996,7 @@ If you want to use different sort keys for each drilldown, use ``drilldown_output_columns`` """""""""""""""""""""""""""" -It specifies output columns for drilldown separated by ``,``. +Specifies output columns for drilldown separated by ``,``. Here is a ``drilldown_output_columns`` example: @@ -1079,7 +1079,7 @@ You can use more :doc:`/reference/columns/pseudo` in ``drilldown_offset`` """""""""""""""""""" -It specifies offset to determine range of drilldown output +Specifies offset to determine range of drilldown output records. Offset is zero-based. ``--drilldown_offset 1`` means output range is started from the 2nd record. @@ -1121,7 +1121,7 @@ The default value of ``drilldown_offset`` is ``0``. ``drilldown_limit`` """"""""""""""""""" -It specifies the max number of groups in a drilldown. If the number of +Specifies the max number of groups in a drilldown. If the number of groups is less than ``drilldown_limit``, all groups are outputted. Here is a ``drilldown_limit`` example: @@ -1162,7 +1162,7 @@ The default value of ``drilldown_limit`` is ``10``. ``drilldown_calc_types`` """""""""""""""""""""""" -It specifies how to calculate (aggregate) values in grouped records by +Specifies how to calculate (aggregate) values in grouped records by a drilldown. You can specify multiple calculation types separated by "``,``". For example, ``MAX,MIN``. @@ -1309,7 +1309,7 @@ that only ``COUNT`` is enabled. Because ``NONE`` is just ignored and ``drilldown_calc_target`` """"""""""""""""""""""""" -It specifies the target column for :ref:`select-drilldown-calc-types`. +Specifies the target column for :ref:`select-drilldown-calc-types`. If you specify a calculation type that needs a target column such as ``MAX`` in :ref:`select-drilldown-calc-types` but you omit @@ -1555,7 +1555,7 @@ There is a score related parameter, ``adjuster``. ``adjuster`` """""""""""" -It specifies one or more score adjust expressions. You need to use +Specifies one or more score adjust expressions. You need to use ``adjuster`` with ``query`` or ``filter``. ``adjuster`` doesn't work with not searched request. Modified: doc/source/reference/commands/suggest.rst (+12 -12) =================================================================== --- doc/source/reference/commands/suggest.rst 2015-02-19 18:40:38 +0900 (d67f966) +++ doc/source/reference/commands/suggest.rst 2015-02-20 00:32:33 +0900 (c6f6116) @@ -100,7 +100,7 @@ Parameters ---------- ``types`` - It specifies what types are returned by the suggest + Specifies what types are returned by the suggest command. Here are available types: @@ -130,46 +130,46 @@ Parameters complete|correct|suggest ``table`` - It specifies table name that has ``item_${DATA_SET_NAME}`` format. + Specifies table name that has ``item_${DATA_SET_NAME}`` format. For example, ``item_query`` is a table name if you created dataset by the following command:: groonga-suggest-create-dataset /tmp/db-path query ``column`` - It specifies a column name that has furigana in + Specifies a column name that has furigana in Katakana in ``table`` table. ``query`` - It specifies query for completion, correction and/or + Specifies query for completion, correction and/or suggestion. ``sortby`` - It specifies sort key. + Specifies sort key. Default: ``-_score`` ``output_columns`` - It specifies output columns. + Specifies output columns. Default: ``_key,_score`` ``offset`` - It specifies returned records offset. + Specifies returned records offset. Default: ``0`` ``limit`` - It specifies number of returned records. + Specifies number of returned records. Default: ``10`` ``frequency_threshold`` - It specifies threshold for item frequency. Returned records must have + Specifies threshold for item frequency. Returned records must have ``_score`` that is greater than or equal to ``frequency_threshold``. Default: @@ -177,7 +177,7 @@ Parameters ``conditional_probability_threshold`` - It specifies threshold for conditional + Specifies threshold for conditional probability. Conditional probability is used for learned data. It is probability of query submission when ``query`` is occurred. Returned records must have conditional @@ -188,7 +188,7 @@ Parameters ``0.2`` ``prefix_search`` - It specifies whether optional prefix search is used or not + Specifies whether optional prefix search is used or not in completion. Here are available values: @@ -207,7 +207,7 @@ Parameters ``auto`` ``similar_search`` - It specifies whether optional similar search is used or not + Specifies whether optional similar search is used or not in correction. Here are available values: Modified: doc/source/reference/commands/table_create.rst (+7 -7) =================================================================== --- doc/source/reference/commands/table_create.rst 2015-02-19 18:40:38 +0900 (fabead9) +++ doc/source/reference/commands/table_create.rst 2015-02-20 00:32:33 +0900 (f6cadae) @@ -159,7 +159,7 @@ This section describes all parameters. ``name`` ^^^^^^^^ -It specifies a table name to be created. ``name`` must be specified. +Specifies a table name to be created. ``name`` must be specified. Here are available characters: @@ -179,7 +179,7 @@ that you cannot use ``_`` as the first character such as ``flags`` ^^^^^^^^^ -It specifies a table type and table customize options. +Specifies a table type and table customize options. Here are available flags: @@ -216,7 +216,7 @@ The default flags are ``TABLE_HASH_KEY``. ``key_type`` ^^^^^^^^^^^^ -It specifies key type. +Specifies key type. If you specify ``TABLE_HASH_KEY``, ``TABLE_PAT_KEY`` or ``TABLE_DAT_KEY`` as ``flags`` parameter, you need to specify @@ -229,7 +229,7 @@ The default value is none. ``value_type`` ^^^^^^^^^^^^^^ -It specifies value type. +Specifies value type. You can use value when you specify ``TABLE_NO_KEY``, ``TABLE_HASH_KEY`` or ``TABLE_PAT_KEY`` as ``flags`` parameter. Value @@ -241,7 +241,7 @@ The default value is none. ``default_tokenizer`` ^^^^^^^^^^^^^^^^^^^^^ -It specifies the default tokenizer that is used on searching and data +Specifies the default tokenizer that is used on searching and data loading. You cannot use ``default_tokenizer`` with ``TABLE_NO_KEY`` because @@ -259,7 +259,7 @@ The default value is none. ``normalizer`` ^^^^^^^^^^^^^^ -It specifies a normalizer that is used to normalize key. +Specifies a normalizer that is used to normalize key. You cannot use ``normalizer`` with ``TABLE_NO_KEY`` because ``TABLE_NO_KEY`` doesn't support key. @@ -273,7 +273,7 @@ The default value is none. ``token_filters`` ^^^^^^^^^^^^^^^^^^ -It specifies token filters that is used to some processes tokenized token. +Specifies token filters that is used to some processes tokenized token. You cannot use ``token_filters`` with ``TABLE_NO_KEY`` because ``TABLE_NO_KEY`` doesn't support key. Modified: doc/source/reference/commands/table_tokenize.rst (+4 -4) =================================================================== --- doc/source/reference/commands/table_tokenize.rst 2015-02-19 18:40:38 +0900 (81c118d) +++ doc/source/reference/commands/table_tokenize.rst 2015-02-20 00:32:33 +0900 (0dcacf9) @@ -60,14 +60,14 @@ There are required parameters, ``table`` and ``string``. ``table`` """"""""" -It specifies the lexicon table. ``table_tokenize`` command uses the +Specifies the lexicon table. ``table_tokenize`` command uses the tokenizer, the normalizer, the token filters that is set the lexicon table. ``string`` """""""""" -It specifies any string which you want to tokenize. +Specifies any string which you want to tokenize. See :ref:`tokenize-string` option in :doc:`/reference/commands/tokenize` about details. @@ -79,7 +79,7 @@ There are optional parameters. ``flags`` """"""""" -It specifies a tokenization customize options. You can specify +Specifies a tokenization customize options. You can specify multiple options separated by "``|``". The default value is ``NONE``. @@ -89,7 +89,7 @@ See :ref:`tokenize-flags` option in :doc:`/reference/commands/tokenize` about de ``mode`` """""""" -It specifies a tokenize mode. +Specifies a tokenize mode. The default value is ``GET``. Modified: doc/source/reference/commands/tokenize.rst (+6 -6) =================================================================== --- doc/source/reference/commands/tokenize.rst 2015-02-19 18:40:38 +0900 (d5fc6d1) +++ doc/source/reference/commands/tokenize.rst 2015-02-20 00:32:33 +0900 (e5987b0) @@ -57,7 +57,7 @@ There are required parameters, ``tokenizer`` and ``string``. ``tokenizer`` """"""""""""" -It specifies the tokenizer name. ``tokenize`` command uses the +Specifies the tokenizer name. ``tokenize`` command uses the tokenizer that is named ``tokenizer``. See :doc:`/reference/tokenizers` about built-in tokenizers. @@ -78,7 +78,7 @@ registering ``tokenizers/kytea``. ``string`` """""""""" -It specifies any string which you want to tokenize. +Specifies any string which you want to tokenize. If you want to include spaces in ``string``, you need to quote ``string`` by single quotation (``'``) or double quotation (``"``). @@ -99,7 +99,7 @@ There are optional parameters. ``normalizer`` """""""""""""" -It specifies the normalizer name. ``tokenize`` command uses the +Specifies the normalizer name. ``tokenize`` command uses the normalizer that is named ``normalizer``. Normalizer is important for N-gram family tokenizers such as ``TokenBigram``. @@ -140,7 +140,7 @@ to lower case characters. For example, ``fu`` is a token. ``flags`` """"""""" -It specifies a tokenization customize options. You can specify +Specifies a tokenization customize options. You can specify multiple options separated by "``|``". For example, ``NONE|ENABLE_TOKENIZED_DELIMITER``. @@ -178,7 +178,7 @@ tokenized delimiter. ``mode`` """""""" -It specifies a tokenize mode. If the mode is specified ``ADD``, the text +Specifies a tokenize mode. If the mode is specified ``ADD``, the text is tokenized by the rule that adding a document. If the mode is specified ``GET``, the text is tokenized by the rule that searching a document. If the mode is omitted, the text is tokenized by the ``ADD`` mode. @@ -206,7 +206,7 @@ The last alphabet is tokenized by two characters. ``token_filters`` """"""""""""""""" -It specifies the token filter names. ``tokenize`` command uses the +Specifies the token filter names. ``tokenize`` command uses the tokenizer that is named ``token_filters``. See :doc:`/reference/token_filters` about token filters. Modified: doc/source/reference/commands/truncate.rst (+1 -1) =================================================================== --- doc/source/reference/commands/truncate.rst 2015-02-19 18:40:38 +0900 (6f02591) +++ doc/source/reference/commands/truncate.rst 2015-02-20 00:32:33 +0900 (fb565ad) @@ -78,7 +78,7 @@ There is required parameter, ``target_name``. ``target_name`` """"""""""""""" -It specifies the name of table or column. +Specifies the name of table or column. Return value ------------ Modified: doc/source/reference/functions/between.rst (+5 -5) =================================================================== --- doc/source/reference/functions/between.rst 2015-02-19 18:40:38 +0900 (3b63dc4) +++ doc/source/reference/functions/between.rst 2015-02-20 00:32:33 +0900 (ee33bb1) @@ -85,30 +85,30 @@ There are five required parameters, ``column_or_value``, and ``min``, ``min_bord ``column_or_value`` ^^^^^^^^^^^^^^^^^^^ -It specifies a column of the table or the value. +Specifies a column of the table or the value. ``min`` ^^^^^^^^^^^^^^^^^^^ -It specifies the minimal border value of the range. +Specifies the minimal border value of the range. You can control the behavior that the value of ``max`` is included or excluded by ``max_border`` parameter. ``min_border`` ^^^^^^^^^^^^^^^^^^^ -It specifies whether the specified range contains the value of ``min`` or not. +Specifies whether the specified range contains the value of ``min`` or not. The value of ``min_border`` are either "include" or "exclude". If it is "include", ``min`` value is included. If it is "exclude", ``min`` value is not included. ``max`` ^^^^^^^^^^^^^^^^^^^ -It specifies the maximum border value of the range. +Specifies the maximum border value of the range. You can control the behavior that the value of ``max`` is included or excluded by ``max_border`` parameter. ``max_border`` ^^^^^^^^^^^^^^^^^^^ -It specifies whether the specified range contains the value of ``max`` or not. +Specifies whether the specified range contains the value of ``max`` or not. The value of ``max_border`` are either "include" or "exclude". If it is "include", ``max`` value is included. If it is "exclude", ``max`` value is not included. Return value Modified: doc/source/reference/functions/geo_distance.rst (+3 -3) =================================================================== --- doc/source/reference/functions/geo_distance.rst 2015-02-19 18:40:38 +0900 (9d00f88) +++ doc/source/reference/functions/geo_distance.rst 2015-02-20 00:32:33 +0900 (fa922cc) @@ -153,7 +153,7 @@ There are two required parameter, ``point1`` and ``point2``. ``point1`` """""""""" -It specifies the start point that +Specifies the start point that you want to calculate the value of distance between two points. You can specify the value of GeoPoint type. [#]_ @@ -163,7 +163,7 @@ See :doc:`/reference/types` about GeoPoint. ``point2`` """""""""" -It specifies the end point that +Specifies the end point that you want to calculate the value of distance between two points. You can specify the value of GeoPoint type or @@ -179,7 +179,7 @@ There is a optional parameter, ``approximate_type``. ``approximate_type`` """""""""""""""""""" -It specifies how to approximate the geographical features for calculating +Specifies how to approximate the geographical features for calculating the value of distance. You can specify the value of ``approximate_type`` by one of the followings. Modified: doc/source/reference/functions/highlight_full.rst (+6 -6) =================================================================== --- doc/source/reference/functions/highlight_full.rst 2015-02-19 18:40:38 +0900 (0b919a2) +++ doc/source/reference/functions/highlight_full.rst 2015-02-20 00:32:33 +0900 (ed035a4) @@ -88,35 +88,35 @@ There are three or over optional parameters, ``keywordN``, ``open_tagN`` and ``e ``column`` ^^^^^^^^^^ -It specifies a column of the table. +Specifies a column of the table. ``normalizer_name`` ^^^^^^^^^^^^^^^^^^^ -It specifies a normalizer name. +Specifies a normalizer name. ``use_html_escape`` ^^^^^^^^^^^^^^^^^^^ -It specifies use or not use HTML escape. If it is ``true`` , use HTML escape. +Specifies use or not use HTML escape. If it is ``true`` , use HTML escape. If it is ``false`` , not use HTML escape. ``keywordN`` ^^^^^^^^^^^^ -It specifies a keyword for tagging. +Specifies a keyword for tagging. You can specify multiple keywords for each three arguments. ``open_tagN`` ^^^^^^^^^^^^^ -It specifies a open tag. +Specifies a open tag. You can specify multiple open tags for each three arguments. ``close_tagN`` ^^^^^^^^^^^^^^ -It specifies a close tag. +Specifies a close tag. You can specify multiple close tags for each three arguments. Return value Modified: doc/source/reference/functions/highlight_html.rst (+1 -1) =================================================================== --- doc/source/reference/functions/highlight_html.rst 2015-02-19 18:40:38 +0900 (533a5bf) +++ doc/source/reference/functions/highlight_html.rst 2015-02-20 00:32:33 +0900 (3af392a) @@ -85,7 +85,7 @@ There is only one parameter ``column`` . ``column`` ^^^^^^^^^^ -It specifies a column of the table. +Specifies a column of the table. Return value ------------ Modified: doc/source/reference/functions/html_untag.rst (+1 -1) =================================================================== --- doc/source/reference/functions/html_untag.rst 2015-02-19 18:40:38 +0900 (752fa09) +++ doc/source/reference/functions/html_untag.rst 2015-02-20 00:32:33 +0900 (63fa136) @@ -72,7 +72,7 @@ There is one required parameter, ``html``. ``html`` ^^^^^^^^ -It specifies HTML text to be untagged. +Specifies HTML text to be untagged. Return value ------------ Modified: doc/source/reference/functions/in_values.rst (+2 -2) =================================================================== --- doc/source/reference/functions/in_values.rst 2015-02-19 18:40:38 +0900 (9871834) +++ doc/source/reference/functions/in_values.rst 2015-02-20 00:32:33 +0900 (098bd6f) @@ -67,12 +67,12 @@ There are two or more required parameter, ``target_value`` and multiple ``value` ``target_value`` ^^^^^^^^^^^^^^^^ -It specifies a column of the table that is specified by ``table`` parameter in ``select``. +Specifies a column of the table that is specified by ``table`` parameter in ``select``. ``value`` ^^^^^^^^^ -It specifies a value of the column which you want to select. +Specifies a value of the column which you want to select. Return value ------------ Modified: doc/source/reference/functions/query.rst (+4 -4) =================================================================== --- doc/source/reference/functions/query.rst 2015-02-19 18:40:38 +0900 (f00fcd4) +++ doc/source/reference/functions/query.rst 2015-02-20 00:32:33 +0900 (d43e115) @@ -114,14 +114,14 @@ There are two required parameter, ``match_columns`` and ``query_string``. ``match_columns`` """"""""""""""""" -It specifies the default target column for fulltext search by +Specifies the default target column for fulltext search by ``query_string`` parameter value. It is the same role as :ref:`select-match-columns` parameter in ``select``. ``query_string`` """""""""""""""" -It specifies the search condition in +Specifies the search condition in :doc:`/reference/grn_expr/query_syntax`. It is the same role as ``query`` parameter in ``select``. @@ -136,7 +136,7 @@ There are some optional parameters. ``query_expander`` """""""""""""""""" -It specifies the plugin name for query expansion. +Specifies the plugin name for query expansion. There is one plugin bundled in official release - :doc:`/reference/query_expanders/tsv`. @@ -146,7 +146,7 @@ See :doc:`/reference/query_expanders/tsv` about details. ``substitution_table`` """""""""""""""""""""" -It specifies the substitution table and substitution column name +Specifies the substitution table and substitution column name by following format such as ``${TABLE}.${COLUMN}`` for query expansion. See :ref:`query-expander` about details. Modified: doc/source/reference/functions/sub_filter.rst (+2 -2) =================================================================== --- doc/source/reference/functions/sub_filter.rst 2015-02-19 18:40:38 +0900 (946566f) +++ doc/source/reference/functions/sub_filter.rst 2015-02-20 00:32:33 +0900 (498ba2e) @@ -102,7 +102,7 @@ There are two required parameter, ``scope`` and ``filter_string``. ``scope`` ^^^^^^^^^ -It specifies a column of the table that is specified by ``table`` +Specifies a column of the table that is specified by ``table`` parameter in ``select``. The column has a limitation. The limitation is described later. ``filter_string`` is evaluated in the column context. It means that ``filter_string`` is evaluated like @@ -119,7 +119,7 @@ See :ref:`select-table` about ``table`` parameter in ``select``. ``filter_string`` ^^^^^^^^^^^^^^^^^ -It specifies a search condition in +Specifies a search condition in :doc:`/reference/grn_expr/script_syntax`. It is evaluated in ``scope`` context. -------------- next part -------------- HTML����������������������������...Download