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

Re: Doc reference of contrib modules

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Bruce Momjian <bruce(at)momjian(dot)us>
Cc: Josh Kupershmidt <schmiddy(at)gmail(dot)com>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Doc reference of contrib modules
Date: 2011-01-25 15:17:06
Message-ID: 21985.1295968626@sss.pgh.pa.us (view raw or flat)
Thread:
Lists: pgsql-docs
Bruce Momjian <bruce(at)momjian(dot)us> writes:
> 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?

That's not just awkward, but flat wrong, because the link points to
documentation of the module not the function.  Correct would be
something like

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

			regards, tom lane

In response to

Responses

pgsql-docs by date

Next:From: Bruce MomjianDate: 2011-01-25 15:26:28
Subject: Re: Doc reference of contrib modules
Previous:From: Bruce MomjianDate: 2011-01-25 14:59:52
Subject: Re: Doc reference of contrib modules

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