Ruby - RDoc - ドキュメントを読む


 クラウディア


1. 概要
2. カレントディレクトリ以下しか作れないのか
3. gem でインストールしたものにはあるのか?
4. ruby 3.3

1. 概要

 「pg」のドキュメントを作って読んでみたいと思ってはたと困った・・・。  参考サイトでは、カレントディレクトリ以下の「ruby」のファイルから生成するとしか書いていないような・・・。  「ruby help」とかやってもなんかドキュメントを作成しはじめるし・・・。

2. カレントディレクトリ以下しか作れないのか

 「カレントディレクトリ以下しか作れないのか」と思いまして、ヘルプを読みたかったのですが、ヘルプの出し方がわからない。  やっとヘルプの出し方がわかった  やたら長えや。  なので、以前は掲載していましたが、インストールしている人は、自分で下記のコマンドを打ってください。

rdoc -h
 でまぁ、少し読んだのですが。  オプションの設定の仕方がわからん。

3. gem でインストールしたものにはあるのか?

 と思ったら、「/usr/local/lib/ruby/gems/2.4/gems/pg-1.1.3」配下の「tree」を見てびっくり。

$ tree /usr/local/lib/ruby/gems/2.4/gems/pg-1.1.3
/usr/local/lib/ruby/gems/2.4/gems/pg-1.1.3
|-- BSDL

・・・	略	・・・

    |   |-- type_map_spec.rb
    |   `-- type_spec.rb
    `-- pg_spec.rb

9 directories, 95 files
 9ディレクトリ、95ファイルありまして。

/usr/local/lib/ruby/gems/2.4/gems/pg-1.1.3/README.ja.rdoc
 てのがあるようです。  読んでみたら、日本語ではなかった。  こうなると英語文盲は悲しくなります。  でもまぁ、ドキュメントサイトがあるのはなんとなくわかりました。  「PG: The Ruby PostgreSQL Driver」にあります。  英語ではありますものの、「RDoc」で作成するより、出来上がったものを読む方が楽です。  「RDoc」で作成しても英語でしょうし。  ということで、「RDoc」を実際に使うのはまたの機会になったのです(2018年10月31日)。  まぁ、これが「ruby 2.4」の頃の話ですな。

4. ruby 3.3

 2025年5月14日。  「ruby 3.3」には。

/usr/local/lib/ruby/gems/3.3/gems/pg-1.5.9/README.ja.md
 ちゅうのがあります。  冒頭を掲載しますと。

# pg

* ホーム :: https://github.com/ged/ruby-pg
* ドキュメント :: http://deveiate.org/code/pg (英語)、 https://deveiate.org/code/pg/README_ja_md.html (日本語)
* 変更履歴 :: link:/History.md

[![https://gitter.im/ged/ruby-pg
でチャットに参加](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ged/ruby-pg?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)


## 説明

Pgは[PostgreSQL
RDBMS](http://www.postgresql.org/)へのRubyのインターフェースです。[PostgreSQL
9.3以降](http://www.postgresql.org/support/versioning/)で動作します。
 となっちょりまして。  4行目に着目すると。  「https://deveiate.org/code/pg/README_ja_md.html」となっちょりまして。  これが「PG: The Ruby PostgreSQL Driver」の頃の話ですな。  飛べば、ファイルの内容をブラウザで、読めます。  日本語訳なので、少しは読めそうです。

earthcar(アースカー)