Re: Small documentation issue

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: Albe Laurenz <laurenz(dot)albe(at)wien(dot)gv(dot)at>, pgsql-hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Small documentation issue
Date: 2011-07-05 19:57:30
Message-ID: 23842.1309895850@sss.pgh.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Robert Haas <robertmhaas(at)gmail(dot)com> writes:
> On Fri, Jul 1, 2011 at 3:15 AM, Albe Laurenz <laurenz(dot)albe(at)wien(dot)gv(dot)at> wrote:
>> In fdwhandler.sgml, chapter fdwhandler has only one subsection
>> (fdw-routines).
>>
>> If there is only one subsection, no table of contents is generated in
>> the chapter.
>> That means that people who navigate to the chapter from the main table
>> of contents
>> will not see that there is a subsection.
>>
>> I know too little about the documentation building process, but is it
>> possible
>> to generate a table of contents even if there is only one subsection?

I don't know how to change the doc toolchain to do that either. But
on reflection it seemed to me that this documentation was badly designed
anyhow, because it mixed up description of the FDW's routines with
actual introductory text. I split that into an introduction and a
<sect1> for the routines. Problem solved.

> Maybe we could just add a sentence to the end of the third paragraph
> with a pointer to the section that follows, so it would read like
> this:

> The callback functions are plain C functions and are not visible or
> callable at the SQL level. They are described in more detail in
> Section 50.1.

Yeah, I did that too.

regards, tom lane

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Thom Brown 2011-07-05 20:27:12 Changing extension schema fails silently
Previous Message Dan Ports 2011-07-05 19:54:36 Re: SSI atomic commit