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

Back to archive index

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


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

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

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

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

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

  Modified: doc/source/reference/commands/column_remove.rst (+26 -29)
===================================================================
--- doc/source/reference/commands/column_remove.rst    2014-08-12 08:24:34 +0900 (4bc59d5)
+++ doc/source/reference/commands/column_remove.rst    2014-08-12 08:24:53 +0900 (bd48962)
@@ -2,42 +2,50 @@
 
 .. highlightlang:: none
 
-column_remove
-=============
+``column_remove``
+=================
 
-名前
-----
+Summary
+-------
 
 column_remove - テーブルに定義されているカラムの削除
 
-書式
-----
+Groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、>標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+column_removeはテーブルに定義されているカラムを削除します。
+また、付随するインデックスも削除されます。[#]_
+
+Syntax
+------
 ::
 
  column_remove table name
 
-説明
-----
+Usage
+-----
+::
 
-Groonga組込コマンドの一つであるcolumn_removeについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+ column_remove Entry body
 
-column_removeはテーブルに定義されているカラムを削除します。
-また、付随するインデックスも削除されます。[#]_
+ [true]
+
+.. rubric:: 脚注
+
+.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。
 
-引数
-----
+Parameters
+----------
 
 ``table``
+
   削除対象のカラムが定義されているテーブルの名前を指定します。
 
 ``name``
-  削除対象のカラム名を指定します。
 
-返値
-----
+  削除対象のカラム名を指定します。
 
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -47,14 +55,3 @@ json形式
 
    エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-::
-
- column_remove Entry body
-
- [true]
-
-.. rubric:: 脚注
-
-.. [#] マルチセクションインデックスの一部である場合も、インデックスが削除されます。
-------------- next part --------------
HTML����������������������������...
下載 



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