joppot

コピペで絶対動く。説明を妥協しない

プログラミング

gemspecのsummary項目とdescription項目の違いに付いて

投稿日:


89h

概要

みなさんこんにちはcandleです。

gemを自作していたら、gemspecのところでsummaryとdescriptionの違いが分からなかったので、
調べたら、公式ページに書いてあったので、まとめておきます。


参考にしたサイト

http://guides.rubygems.org/specification-reference/#description
http://guides.rubygems.org/specification-reference/#summary


summaryとdescriptionの違いについて

一般に、gemを作成すると「Gem名.gemspec」というファイルが作成され、その中の項目にsummaryとdescriptionがあります。

公式にサイトにはsummaryは

“A short summary of this gem’s description. Displayed in `gem list -d`.
The description should be more detailed than the summary.”

とあります。訳すと以下の様になります。

“summaryの項目はdescriptionより簡潔に記述します。
summaryは`gem list -d`コマンドを使用した時に表示されます。”

サンプルを見ると、だいたい1行で書く事が推奨されているっぽいです。

s.summary = "This is a gem that will help your coding"

一方、descriptionは以下の様に記述されています。

“A long description of this gem
The description should be more detailed than the summary but not excessively long. A few paragraphs is a recommended length with no examples or formatting.”

訳すと。

“gemに付いての比較的長い説明。
descriptionはsummaryよりも長く、詳しく書くが、長過ぎない様に気をつける。
推奨している長さは2〜3段落くらいの文章構成である。”

例では以下の様に書かれています。

s.description = <<-EOF
  Rake is a Make-like program implemented in Ruby. Tasks and
  dependencies are specified in standard Ruby syntax.
EOF

長過ぎないように書くのが親切かと。

まとめ

ユーザーに親切なgemの記述を目指すのは大変ですが、出来るところからやっていきましょう。

スポンサードリンク

「為になったなぁ」と思ったら、シェアお願いします。

-プログラミング
-,

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

railsのsimple-captcha gemを使用してform_forを使ったフォームを画像認証する

概要 みなさんこんにちはcandleです。公に開かれたフォームはスパムや総当り攻撃を受けやすいです。 そこで、画像認証を導入して、悪意のあるフォームを拒否してみましょう。 simple-captcha …

railsのfluent-loggerとdevise gemを使ってユーザーの行動をfluentdサーバに収集する

概要 fluentdと言えば、ビックデータで扱うようなデータを集め出力するサーバですが、これとrailsのfluent-logger gemとdevise gemを組み合わせてユーザーの行動ログをとっ …

Rails pluginを使ったgemの作り方[1](基本設定編)

概要 みなさんこんにちはcandleです。今回からできればシリーズ物として、railsのgemを作っていこうと考えています。なぜかgemの作り方の詳しい解説サイトが日本語で少ないので未だgemを満足に …

railsのcoffee scriptをurl判定をして実行をする方法

概要 みなさんこんにちはcandleです。 今回はcoffeescriptを任意のURLで実行する様にする関数を作ります。 というのはrailsは最終的にassetspiplineでjavascrip …

grepコマンドを使って正規表現を色々試してみるその1

概要 みなさんこんにちはcandleです。今回からgrepコマンドを使って正規表現を色々試してみます。 正規表現って、使えると便利ですが、それを勉強して使いこなせている人って少ないと思います。この機会 …

  • English
  • 日本語

ベンチャー企業のCTOをやってます。大学時代にプログラミングを始め、javaから入門し、C++へて、PHPへと進み、会社ではRailsを使用。自動化が大好きなプログラマー