Re: [DOCS] Added documentation about caching, reliability - Mailing list pgsql-hackers

From Bruce Momjian
Subject Re: [DOCS] Added documentation about caching, reliability
Date
Msg-id 200509290230.j8T2Ue812994@candle.pha.pa.us
Whole thread Raw
In response to Re: [DOCS] Added documentation about caching, reliability  (Alvaro Herrera <alvherre@alvh.no-ip.org>)
List pgsql-hackers
Alvaro Herrera wrote:
> On Wed, Sep 28, 2005 at 10:08:02PM -0400, Bruce Momjian wrote:
>
> > The chapter sections are:
> >
> >     Table of Contents
> >     26.1. Write-Ahead Logging (WAL)
> >     26.2. Benefits of WAL
> >     26.3. WAL Configuration
> >     26.4. WAL Internals
> >
> > Are you suggesting we spell out Write-Ahead Logging for all section
> > titles?
>
> Is it considered good style to use acronyms in titles?  I wouldn't do it.
>
> Maybe it could be left as
>
>      26.1. Write-Ahead Logging
>      26.2. Benefits of Write-Ahead Logging

I modified 26.2 as you suggested.

>      26.3. WAL Configuration
>      26.4. WAL Internals
>
> because the former two talk about WAL in a general manner, while the
> latter two are about our implementation.  I also wouldn't expand the
> acronym in a title.

I think we do need to show the acronym in the title if use that acronym
in later titles.

--
  Bruce Momjian                        |  http://candle.pha.pa.us
  pgman@candle.pha.pa.us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

pgsql-hackers by date:

Previous
From: Alvaro Herrera
Date:
Subject: Re: [DOCS] Added documentation about caching, reliability
Next
From: Tom Lane
Date:
Subject: Re: [PATCHES] Proposed patch for sequence-renaming problems