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

Back to archive index

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


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

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

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

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

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

  Modified: doc/source/reference/commands/table_remove.rst (+19 -24)
===================================================================
--- doc/source/reference/commands/table_remove.rst    2014-08-12 08:27:32 +0900 (a2869e6)
+++ doc/source/reference/commands/table_remove.rst    2014-08-12 08:27:42 +0900 (7d417f7)
@@ -2,38 +2,40 @@
 
 .. highlightlang:: none
 
-table_remove
-============
+``table_remove``
+================
 
-名前
-----
+Summary
+-------
 
 table_remove - テーブルの削除
 
-書式
-----
+groonga組込コマンドの一つであるtable_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+table_removeはテーブルと定義されているカラムを削除します。カラムに付随するインデックスも再帰的に削除されます。
+
+Syntax
+------
 ::
 
  table_remove name
 
-説明
-----
+Usage
+-----
+::
 
-groonga組込コマンドの一つであるtable_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+ table_remove Entry
 
-table_removeはテーブルと定義されているカラムを削除します。カラムに付随するインデックスも再帰的に削除されます。
+ [true]
 
-引数
-----
+Parameters
+----------
 
 ``name``
   削除対象のカラムが定義されているテーブルの名前を指定します。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -43,10 +45,3 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-::
-
- table_remove Entry
-
- [true]
-------------- next part --------------
HTML����������������������������...
Download 



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