# Q: Documentation for PGconn

**URL:** <https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506>\
**Category:** Ruby\
**Created:** [July 30, 2008, 2:15pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506 "2008-07-30T14:15:35Z")\
**Posts on this page:** 6\
**Page:** 1

<div class="post-metadata">

**Author:** ![GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/g/c89c15/32.png) [@GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/u/GSRalph_KuntzS_MD)\
**Post date:** [July 30, 2008, 2:15pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506/1 "2008-07-30T14:15:35Z")

</div>

Is there any documentation for PGconn (or postgres/postgres)? When I  
do ‘ri postgres’ I get the message ‘Nothing known about postgres’,  
even though the module works fine in test cases with jruby and cygwin-  
ruby in Windoze Vi$ta.

---

<div class="post-metadata">

**Author:** ![GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/g/c89c15/32.png) [@GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/u/GSRalph_KuntzS_MD)\
**Post date:** [July 30, 2008, 3:50pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506/2 "2008-07-30T15:50:32Z")

</div>

here’s my recipe:

1. google for ruby postgres
2. enter 1st result (i’m feeling lucky might work too)
3. look for the link “reference”
4. here’s the link also: [http://ruby.scripting.ca/postgres/rdoc/](http://ruby.scripting.ca/postgres/rdoc/)

😉

On 30-07-2008, at 8:14, G. Ralph Kuntz, MD, MS wrote:

> Is there any documentation for PGconn (or postgres/postgres)? When I  
> do ‘ri postgres’ I get the message ‘Nothing known about postgres’,  
> even though the module works fine in test cases with jruby and cygwin-  
> ruby in Windoze Vi$ta.

regards,

---

<div class="post-metadata">

**Author:** ![GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/g/c89c15/32.png) [@GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/u/GSRalph_KuntzS_MD)\
**Post date:** [July 30, 2008, 4:41pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506/3 "2008-07-30T16:41:37Z")

</div>

G. Ralph Kuntz, MD, MS wrote:

> Is there any documentation for PGconn (or postgres/postgres)? When I  
> do ‘ri postgres’ I get the message ‘Nothing known about postgres’,  
> even though the module works fine in test cases with jruby and cygwin-  
> ruby in Windoze Vi$ta.

Or for those of us who can’t be tethered to the Internet _all the  
time_…

1. Check to seen whether you have rdoc installed: rdoc --help
2. If not, get it else…
3. Chdir so you’re in the top level of the package you want to examine
4. Check to see if there’s a ‘doc’ subdirectory
5. If not, ‘rdoc’ and the rdoc will be generated in a new doc directory

---

<div class="post-metadata">

**Author:** ![GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/g/c89c15/32.png) [@GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/u/GSRalph_KuntzS_MD)\
**Post date:** [July 31, 2008, 1:30pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506/4 "2008-07-31T13:30:57Z")

</div>

I did this. The documents are out of date. There is no ‘connect’  
method documented, but there is an ‘open’ method.

I found some docs on my machine in /usr/lib/ruby/gems/1.8/gems/ruby-  
postgres-0.7.1.2006.04.06/doc (cygwin).

I guess that will have to do for now.

Thanks.

---

<div class="post-metadata">

**Author:** ![GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/g/c89c15/32.png) [@GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/u/GSRalph_KuntzS_MD)\
**Post date:** [July 30, 2008, 4:46pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506/5 "2008-07-30T16:46:35Z")

</div>

> 1. If not, ‘rdoc’ and the rdoc will be generated in a new doc directory

\*\* so much for ‘tabs’ \*\*

1. Open the ‘index.html’ file in the doc directory with your browser
2. If the doc directory already exists and you don’t want to trash it:  
‘rdoc --op some-other-directory’ and proceed as above…

---

<div class="post-metadata">

**Author:** ![GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/g/c89c15/32.png) [@GSRalph\_KuntzS\_MD](https://www.ruby-forum.com/u/GSRalph_KuntzS_MD)\
**Post date:** [July 31, 2008, 3:42pm UTC](https://www.ruby-forum.com/t/q-documentation-for-pgconn/144506/6 "2008-07-31T15:42:16Z")

</div>

G. Ralph Kuntz, MD, MS wrote:

> I did this. The documents are out of date. There is no ‘connect’  
> method documented, but there is an ‘open’ method.
> 
> I found some docs on my machine in /usr/lib/ruby/gems/1.8/gems/ruby-  
> postgres-0.7.1.2006.04.06/doc (cygwin).
> 
> I guess that will have to do for now.
> 
> Thanks.

a couple of notes…

if you check to online doc cited earlier, you won’t find a ‘connect’  
method there either.

some possibilities include:

a) ‘connect’ is a private method - rdoc doesn’t cover these by default  
b) ‘connect’ is inherited from a class outside of pkg directory  
c) ‘connect’ has been tagged with :nodoc: for some reason

at this point, ‘grep -r connect \*’ is your friend