Skip site navigation (1) Skip section navigation (2)

Re: Doc reference of contrib modules

From: Josh Kupershmidt <schmiddy(at)gmail(dot)com>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Doc reference of contrib modules
Date: 2011-01-25 04:30:58
Message-ID: AANLkTin7bNN+RFguFVT6JYK7ibA9B9Lzn=s1WuvaYJJE@mail.gmail.com (view raw or flat)
Thread:
Lists: pgsql-docs
On Mon, Jan 24, 2011 at 10:33 PM, Bruce Momjian <bruce(at)momjian(dot)us> wrote:
> Suggestions?

For this bit:

*** 686,693 ****
        AS t1(proname name, prosrc text)
      WHERE proname LIKE 'bytea%';
  </programlisting>
!      The <literal>dblink</> function executes a remote query (see
!      <filename>contrib/dblink</>).  It is declared to return
       <type>record</> since it might be used for any kind of query.
       The actual column set must be specified in the calling query so
       that the parser knows, for example, what <literal>*</> should
--- 686,693 ----
        AS t1(proname name, prosrc text)
      WHERE proname LIKE 'bytea%';
  </programlisting>
!      The <link linkend="CONTRIB-DBLINK">dblink</> function executes
!      a remote query.  It is declared to return
       <type>record</> since it might be used for any kind of query.
       The actual column set must be specified in the calling query so
       that the parser knows, for example, what <literal>*</> should

I think the changed line should explicitly mention "dblink module",
otherwise it's easy to miss that dblink() comes from contrib.
Especially since the target page of that link:
  http://www.postgresql.org/docs/current/static/contrib-dblink.html
doesn't mention the words "contrib" or "module" anywhere (most other
contrib modules have a header saying "Appendix F. Additional Supplied
Modules" at the top of the page, but the dblink function pages don't
since they're subpages of
http://www.postgresql.org/docs/current/static/dblink.html ).

Josh

In response to

Responses

pgsql-docs by date

Next:From: Bruce MomjianDate: 2011-01-25 14:59:52
Subject: Re: Doc reference of contrib modules
Previous:From: Bruce MomjianDate: 2011-01-25 03:33:04
Subject: Re: Doc reference of contrib modules

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group