[groonga-dev,01686] Re: コマンドリファレンスのフォーマット変更に関して手順確認

Back to archive index

HAYASHI Kentaro hayas****@clear*****
2013年 8月 26日 (月) 10:25:30 JST


林です。

On Sat, 24 Aug 2013 13:02:33 +0900
whomb****@motel***** wrote:

> whombです。
> 
> blogroongaに出ている、
> コマンドリファレンスのフォーマット変更に関してですが、
> 手順をおっていて少し気になった点があるので質問させて頂きます。
> 
> Summary (名前のセクションから移動)
> Syntax (書式のセクションから移動)
> Parameters (引数のセクションから移動)
> Usage (例のセクションから移動)
> Return value (返値のセクションから移動)
> 
> の並びで記述するとのことですが、
> ParametersとUsageの並びがブログの手順とcolumn_rename.txtで違っていて、
> どちらが正しいかを確認させて頂きたいです。
> 
> load.txtやnormalize.txtも確認しましたが、
> それぞれ、現状リポジトリに上がっているソースでは以下の並びになっています。
> 
> ブログ		Parameters -> Usage
> column_rename	Usage -> Parameters
> load		Parameters -> Usage
> normalize	Usage -> Parameters
> 

ブログの記述が間違っていました。すみません。
Usage -> Parameters の順が正しいです。
(こういうふうに使います -> 詳細はコレコレですという流れにしたいので)
後ほどblogroongaの該当エントリを修正しておきます。

> ちなみに、こちらは余談ですが、
> doc/source/reference/commands/以下のtxtファイルを変更するという点を
> ブログの手順に加えておいたほうが良いかと思いました。
> 
> 以上です。宜しくお願いいたします。
> 

そうですね、対象ファイルを明示していないとわかりづらいですね。
こちらもエントリに説明を追加しておきます。
指摘していただいて助かりました。

-- 
HAYASHI Kentaro <hayas****@clear*****>




groonga-dev メーリングリストの案内
Back to archive index