Re: Documentation of pg_badkend_pid and stats functions - Mailing list pgsql-docs

From Jim Nasby
Subject Re: Documentation of pg_badkend_pid and stats functions
Date
Msg-id B4117EF4-2CFE-401B-9C8E-B18A51FA556B@decibel.org
Whole thread Raw
In response to Re: Documentation of pg_badkend_pid and stats functions  (Tom Lane <tgl@sss.pgh.pa.us>)
Responses Re: Documentation of pg_badkend_pid and stats functions  (Bruce Momjian <bruce@momjian.us>)
List pgsql-docs
On May 13, 2007, at 6:45 PM, Tom Lane wrote:
> "Jim C. Nasby" <decibel@decibel.org> writes:
>> On Sun, May 13, 2007 at 06:48:01PM -0400, Tom Lane wrote:
>>> Surely a section should not *begin* with a cross-reference to
>>> someplace else.
>
>> My concern is that folks will see the table right below it, not find
>> what they're looking for there, and move on... what about immediately
>> after the table?
>
> Immediately after is fine with me.  For that matter, you could
> probably
> get away with putting it between the introductory para and the table
> proper.  I'm just allergic to sections that don't begin with a topic
> sentence telling you what they are about.

See attached. I wanted to not put it between the paragraph
referencing the table and the table itself, but couldn't think of a
better intro paragraph for the section...

--
Jim Nasby                                            jim@nasby.net
EnterpriseDB      http://enterprisedb.com      512.569.9461 (cell)



Attachment

pgsql-docs by date:

Previous
From: David Fetter
Date:
Subject: Re: [PATCHES] OS/X startup scripts
Next
From: Alvaro Herrera
Date:
Subject: Re: [PATCHES] OS/X startup scripts