joppot

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

プログラミング

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

投稿日:

Pocket

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のaws-sdk gemを使ってs3に画像ファイルをフォームからアップロードする

概要 みなさんこんにちはcandleです。比較的難しいrailsからs3に画像をアップロードする方法を試してみましょう。 一般にサーバ環境にはスケーラビリティ(アクセスの規模に応じて、動的にサーバを動 …

ruby on railsのckeditorでcarrierwaveを使って画像をアップロードする

概要 みなさんこんにちはcandleです。今回はckeditorの画像のアップロードを行ってみたいと思います。 ckeditorの画像のアップロードは公式githubにも記載されているのですが、まあや …

wordpressのコメントフォームを編集し、名前とメールのデフォルト値を設定する

概要 みなさんこんにちはcandleです。今回はwordpressのコメントフォームをオーバーライドしてフォームの「名前」「メールアドレス」「url」のデフォルトバリューを設定したいと思います。 コメ …

ElastiCacheのmemcachedとEC2上のrailsとdalli-elasticacheを使ってキャッシュ管理する

概要 皆さんこんにちはcandleです。今回はaws上にあるElastiCacheというサービスを使って railsのキャッシュを管理したいと思います。 キャッシュというのはwebサービス上でよく使う …

phpでcompassを使った開発の仕方

概要 みなさんこにちはcandleです。今回はphpでcompassを使いたいと思います。 compassは別名scssともいいます。 compassはphpのライブラリが既にあります。 しかし、その …

  • English
  • 日本語

プロフィール


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

スポンサードリンク

アーカイブ