[Groonga-commit] groonga/groonga at 6db155e [master] doc: follow new markup guideline about delete command documentation

Back to archive index

HAYASHI Kentaro null+****@clear*****
Wed Sep 25 12:36:18 JST 2013


HAYASHI Kentaro	2013-09-25 12:36:18 +0900 (Wed, 25 Sep 2013)

  New Revision: 6db155e9cf4b054998eaf70cc47c0df37003738b
  https://github.com/groonga/groonga/commit/6db155e9cf4b054998eaf70cc47c0df37003738b

  Merged ce9e5c2: Merge pull request #104 from kenhys/delete

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

  Modified files:
    doc/source/reference/commands/delete.txt

  Modified: doc/source/reference/commands/delete.txt (+20 -22)
===================================================================
--- doc/source/reference/commands/delete.txt    2013-09-25 12:18:08 +0900 (1f450d6)
+++ doc/source/reference/commands/delete.txt    2013-09-25 12:36:18 +0900 (6696717)
@@ -2,29 +2,35 @@
 
 .. highlightlang:: none
 
-delete
-======
+``delete``
+==========
 
-名前
-----
+Summary
+-------
 
 delete - 一件のレコードの削除
 
-書式
-----
+groonga組込コマンドの一つであるdeleteについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+deleteは、使用しているデータベースのテーブルに1件のレコードを削除します。
+
+Syntax
+------
 ::
 
  delete table [key [id [filter]]]
 
-説明
-----
+Usage
+-----
 
-groonga組込コマンドの一つであるdeleteについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+テーブルEntryからレコードを削除します。::
 
-deleteは、使用しているデータベースのテーブルに1件のレコードを削除します。
+ delete Entry abandon
 
-引数
-----
+ [true]
+
+Parameters
+----------
 
 ``table``
 
@@ -42,8 +48,8 @@ deleteは、使用しているデータベースのテーブルに1件のレコ
 
   script形式のgrn_expr文字列によってレコードを指定します。filterパラメータを指定する場合は、id及びkeyパラメータを指定してはいけません。
 
-返値
----
+Return value
+------------
 
 json形式
 ^^^^^^^^
@@ -56,14 +62,6 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-
-テーブルEntryからレコードを削除します。::
-
- delete Entry abandon
-
- [true]
 
 関連項目
 --------
-------------- next part --------------
HTML����������������������������...
Download 



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