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

From Alvaro Herrera
Subject Re: [DOCS] Added documentation about caching, reliability
Date
Msg-id 20050929022349.GB17404@surnet.cl
Whole thread Raw
In response to Re: [DOCS] Added documentation about caching, reliability  (Bruce Momjian <pgman@candle.pha.pa.us>)
Responses Re: [DOCS] Added documentation about caching, reliability
List pgsql-hackers
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
     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.

--
Alvaro Herrera       Valdivia, Chile   ICBM: S 39º 49' 17.7", W 73º 14' 26.8"
Thou shalt study thy libraries and strive not to reinvent them without
cause, that thy code may be short and readable and thy days pleasant
and productive. (7th Commandment for C Programmers)

pgsql-hackers by date:

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