[Groonga-commit] groonga/groonga at e2a1f42 [master] doc: follow new markup guideline about define_selector command documentation

Back to archive index

naoa null+****@clear*****
Tue Aug 12 08:25:12 JST 2014


naoa	2014-08-12 08:25:12 +0900 (Tue, 12 Aug 2014)

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

  Merged 13a8eb1: Merge pull request #189 from naoa/reformat-command-reference

  Message:
    doc: follow new markup guideline about define_selector command documentation

  Modified files:
    doc/source/reference/commands/define_selector.rst

  Modified: doc/source/reference/commands/define_selector.rst (+20 -26)
===================================================================
--- doc/source/reference/commands/define_selector.rst    2014-08-12 08:24:53 +0900 (84e5912)
+++ doc/source/reference/commands/define_selector.rst    2014-08-12 08:25:12 +0900 (5d75edb)
@@ -2,31 +2,36 @@
 
 .. highlightlang:: none
 
-define_selector
-===============
+``define_selector``
+===================
 
-名前
-----
+Summary
+-------
 
 define_selector - 検索コマンドを定義
 
-書式
-----
+Groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数>、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。
+
+Syntax
+------
 ::
 
  define_selector name table [match_columns [query [filter [scorer [sortby
                  [output_columns [offset [limit [drilldown [drilldown_sortby
                  [drilldown_output_columns [drilldown_offset [drilldown_limit]]]]]]]]]]]]]
 
-説明
-----
+Usage
+-----
 
-Groonga組込コマンドの一つであるdefine_selectorについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。::
 
-define_selectorは、検索条件をカスタマイズした新たな検索コマンドを定義します。
+ define_selector entry_selector Entry
+ [true]
 
-引数
-----
+Parameters
+----------
 
 ``name``
 
@@ -88,11 +93,8 @@ define_selectorは、検索条件をカスタマイズした新たな検索コ
 
   追加するselectorコマンドのdrilldown_limit引数のデフォルト値を指定します。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -102,15 +104,7 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-
-テーブルEntryの全レコード・全カラムの値を出力するselectorコマンドを定義します。::
-
- define_selector entry_selector Entry
- [true]
-
-関連項目
+See also
 --------
 
 :doc:`/reference/grn_expr`
-------------- next part --------------
HTML����������������������������...
下載 



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