pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Bruce Momjian <bruce@momjian.us>
To: Josh Kupershmidt <schmiddy@gmail.com>
Cc: Tom Lane <tgl@sss.pgh.pa.us>
Cc: PostgreSQL-documentation <pgsql-docs@postgresql.org>
Subject: Re: Doc reference of contrib modules
Date: Tue, 25 Jan 2011 09:59:52 -0500 (EST)
Message-ID: <201101251459.p0PExqj11486@momjian.us> (raw)
In-Reply-To: <AANLkTin7bNN+RFguFVT6JYK7ibA9B9Lzn=s1WuvaYJJE@mail.gmail.com>

Josh Kupershmidt wrote:
> On Mon, Jan 24, 2011 at 10:33 PM, Bruce Momjian <bruce@momjian.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 ).

That is an interesting case.  I didn't mention "module" here because
above this ia a dblink() function call, and we are referencing the
function call in the text.  I couldn't figure out how to mention
"module" here without making the text more complex.  I thought of:

	The <link linkend="CONTRIB-DBLINK">dblink</> function (part of the
	dblink module) executes a remote query.

but that seems awkward.  Ideas?

-- 
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

  + It's impossible for everything to be true. +



view thread (14+ messages)  latest in thread

Message-ID: <201101251459.p0PExqj11486@momjian.us>
Permalink:  ../201101251459.p0PExqj11486@momjian.us/
Also on:    postgresql.org/message-id/201101251459.p0PExqj11486@momjian.us

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients from your mail client; the link fills in
  the headers below: reply via email
  Some clients, webmail especially, drop In-Reply-To and References from
  a link, and the reply then starts a new thread: use the mbox below.

  To: pgsql-docs@postgresql.org
  Cc: bruce@momjian.us, schmiddy@gmail.com, tgl@sss.pgh.pa.us
  Subject: Re: Doc reference of contrib modules
  In-Reply-To: <201101251459.p0PExqj11486@momjian.us>
  References: <AANLkTin7bNN+RFguFVT6JYK7ibA9B9Lzn=s1WuvaYJJE@mail.gmail.com> <201101251459.p0PExqj11486@momjian.us>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox