Received: from maia.hub.org (maia-2.hub.org [200.46.204.251]) by mail.postgresql.org (Postfix) with ESMTP id 71D411337B8B for ; Tue, 25 Jan 2011 11:00:09 -0400 (AST) Received: from mail.postgresql.org ([200.46.204.86]) by maia.hub.org (mx1.hub.org [200.46.204.251]) (amavisd-maia, port 10024) with ESMTP id 32428-04 for ; Tue, 25 Jan 2011 15:00:00 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from momjian.us (momjian.us [70.90.9.53]) by mail.postgresql.org (Postfix) with ESMTP id 02A561337B77 for ; Tue, 25 Jan 2011 10:59:59 -0400 (AST) Received: (from bruce@localhost) by momjian.us (8.11.6/8.11.6) id p0PExqj11486; Tue, 25 Jan 2011 09:59:52 -0500 (EST) From: Bruce Momjian Message-Id: <201101251459.p0PExqj11486@momjian.us> Subject: Re: Doc reference of contrib modules In-Reply-To: To: Josh Kupershmidt Date: Tue, 25 Jan 2011 09:59:52 -0500 (EST) CC: Tom Lane , PostgreSQL-documentation X-Mailer: ELM [version 2.4ME+ PL124 (25)] MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset="US-ASCII" X-Virus-Scanned: Maia Mailguard 1.0.1 X-Spam-Status: No, hits=-1.91 tagged_above=-5 required=5 tests=BAYES_00=-1.9, T_RP_MATCHES_RCVD=-0.01 X-Spam-Level: X-Archive-Number: 201101/29 X-Sequence-Number: 6321 Josh Kupershmidt wrote: > On Mon, Jan 24, 2011 at 10:33 PM, Bruce Momjian wrote: > > Suggestions? > > For this bit: > > *** 686,693 **** > AS t1(proname name, prosrc text) > WHERE proname LIKE 'bytea%'; > > ! The dblink function executes a remote query (see > ! contrib/dblink). It is declared to return > 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 * should > --- 686,693 ---- > AS t1(proname name, prosrc text) > WHERE proname LIKE 'bytea%'; > > ! The dblink function executes > ! a remote query. It is declared to return > 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 * 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 dblink function (part of the dblink module) executes a remote query. but that seems awkward. Ideas? -- Bruce Momjian http://momjian.us EnterpriseDB http://enterprisedb.com + It's impossible for everything to be true. +