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

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

関連記事

ruby on rails のckeditor gemの機能ボタンをカスタマイズする

概要 みなさんこんにちはcandleです。今回はruby on rails のckeditor gemのショートカットボタンをカスタマイズして自分が必要な機能のみを表示してみましょう。 前提 cked …

wordpressのwp_queryでpost投稿の記事一覧を取得する

概要 みなさんこんにちはcandleです。 最近はwordpressの開発を行っており、そこで、試行錯誤したwp_queryを使った記事一覧の取得の仕方を紹介します。wordpressは少し前まで、q …

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

概要 みなさんこんにちはcandleです。今回は前回に引き続き、正規表現を勉強していきましょう。 前提 unixを使用するので、多少、unixコマンドになれていること サンプル文章 今回は下の文章を用 …

wordpressで任意のサブカテゴリー全てをget_categoriesで取得する

概要 みなさんこんにちはcandleです。今回はwordpress開発でよくあるサブカテゴリーを全て取得する方法を紹介します。 カテゴリー一覧をサイドバーに表示したい時があります。この時、get_ca …

javascript + Reactでhtmlタグの削除と許可とXSS対策

概要 みなさんこんにちはcandleです。今回はReactで許可したhtmlタグだけを表示し、それ以外のタグは削除するプログラムを書いてみます。 注意、本来ユーザーなどが投稿した内容をそのまま表示させ …

  • English
  • 日本語

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