Re: Added documentation about caching, reliability

From: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
To: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>, PostgreSQL-documentation <pgsql-docs(at)postgresql(dot)org>
Subject: Re: Added documentation about caching, reliability
Date: 2005-09-29 02:23:49
Message-ID: 20050929022349.GB17404@surnet.cl
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs 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)

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Bruce Momjian 2005-09-29 02:30:40 Re: Added documentation about caching, reliability
Previous Message Rich Morin 2005-09-29 02:22:14 Re: INSTALL file nits

Browse pgsql-hackers by date

  From Date Subject
Next Message Bruce Momjian 2005-09-29 02:30:40 Re: Added documentation about caching, reliability
Previous Message Bruce Momjian 2005-09-29 02:23:01 Re: [PATCHES] Proposed patch for sequence-renaming problems