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

Back to archive index

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


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

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

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

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

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

  Modified: doc/source/reference/commands/log_put.rst (+20 -26)
===================================================================
--- doc/source/reference/commands/log_put.rst    2014-08-12 08:25:55 +0900 (73bd344)
+++ doc/source/reference/commands/log_put.rst    2014-08-12 08:26:06 +0900 (8ee5ac0)
@@ -2,29 +2,33 @@
 
 .. highlightlang:: none
 
-log_put
-=======
+``log_put``
+===========
 
-名前
-----
+Summary
+-------
 
 log_put - ログ出力
 
-書式
-----
+groonga組込コマンドの一つであるlog_putについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入>力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+
+log_putは、ログにmessageを出力します。
+
+Syntax
+------
 ::
 
  log_put level message
 
-説明
-----
-
-groonga組込コマンドの一つであるlog_putについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。
+Usage
+-----
+::
 
-log_putは、ログにmessageを出力します。
+ log_put ERROR ****MESSAGE****
+ [true]
 
-引数
-----
+Parameters
+----------
 
 ``level``
 
@@ -43,11 +47,8 @@ log_putは、ログにmessageを出力します。
 
   出力する文字列を指定します。
 
-返値
-----
-
-json形式
-^^^^^^^^
+Return value
+------------
 
 ::
 
@@ -57,14 +58,7 @@ json形式
 
   エラーが生じなかった場合にはtrue、エラーが生じた場合にはfalseを返す。
 
-例
---
-::
-
- log_put ERROR ****MESSAGE****
- [true]
-
-関連項目
+See also
 --------
 
 :doc:`log_level`
-------------- next part --------------
HTML����������������������������...
Download 



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