Re: [PATCHES] Autovacuum docs

2005-09-13 Thread Michael Paesold

Alvaro Herrera wrote:

These settings control the default behavior for the autovacuum daemon.
Please refer to _Section 22.1.4_ for more information.

I don't see how to cleanly fit The auto-vacuum daemon in that sentence
in a way that looks like a reference.

So, in short, if there is a policy on this, I propose to update it to
use endterm wherever the surrounding text allows it.


IIRC the reasoning for not using endterm is that the docs should work well 
with output formats that don't have hyperlinks, e.g. print. There it is 
necessary to include the section number for easy navigation.


Best Regards,
Michael Paesold 



---(end of broadcast)---
TIP 3: Have you checked our extensive FAQ?

  http://www.postgresql.org/docs/faq


Re: [PATCHES] Autovacuum docs

2005-09-13 Thread Peter Eisentraut
Tom Lane wrote:
 I think we mostly don't use endterm on cross-references to sections.
 Not sure if that's a project standard, or just laziness, though.

Yes, please don't use those.

 The other sect2 titles in this chapter capitalize only the first
 word. Again, I'm not sure how fully that convention is followed, but
 I think this would look better as The auto-vacuum daemon.

More likely it's The autovacuum daemon without hyphen, which is the 
spelling the actual text uses.   But I'd personally rather see 
consistent title capitalization on all section levels.

-- 
Peter Eisentraut
http://developer.postgresql.org/~petere/

---(end of broadcast)---
TIP 5: don't forget to increase your free space map settings