[Groonga-commit] groonga/groonga at 85392b9 [master] doc: follow new markup guideline about table_list command documentation

Back to archive index

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


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

  New Revision: 85392b9caaf145301f203a31e4efd521eb21032e
  https://github.com/groonga/groonga/commit/85392b9caaf145301f203a31e4efd521eb21032e

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

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

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

  Modified: doc/source/reference/commands/table_list.rst (+20 -22)
===================================================================
--- doc/source/reference/commands/table_list.rst    2014-08-12 08:27:19 +0900 (c5ed768)
+++ doc/source/reference/commands/table_list.rst    2014-08-12 08:27:32 +0900 (cc9887f)
@@ -2,37 +2,38 @@
 
 .. highlightlang:: none
 
-table_list
-==========
+``table_list``
+==============
 
-名前
-----
+Summary
+-------
 
 table_list - DBに定義されているテーブルをリスト表示
 
-書式
-----
-::
+Groonga組込コマンドの一つであるtable_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準
+入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
 
- table_list
+table_listは、DBに定義されているテーブルのリストを表示します。
 
-説明
-----
+Syntax
+------
+::
 
-Groonga組込コマンドの一つであるtable_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+ table_list
 
-table_listは、DBに定義されているテーブルのリストを表示します。
+Usage
+-----
+.. groonga-command
+.. include:: ../../example/reference/commands/table_list.log
+.. table_list
 
-引数
-----
+Parameters
+----------
 
 ありません。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 テーブル名一覧が以下の形式で返却されます。::
 
@@ -76,6 +77,3 @@ json形式
   ``テーブル情報名n`` で示された情報の配列を出力します。
   情報の順序は ``テーブル情報名n`` の順序と同じです。
 
-.. groonga-command
-.. include:: ../../example/reference/commands/table_list.log
-.. table_list
-------------- next part --------------
HTML����������������������������...
Download 



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