Skip site navigation (1) Skip section navigation (2)

Re: Added documentation about caching, reliability

From: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
To: Alvaro Herrera <alvherre(at)alvh(dot)no-ip(dot)org>
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:30:40
Message-ID: 200509290230.j8T2Ue812994@candle.pha.pa.us (view raw or flat)
Thread:
Lists: pgsql-docspgsql-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(at)candle(dot)pha(dot)pa(dot)us               |  (610) 359-1001
  +  If your life is a hard drive,     |  13 Roberts Road
  +  Christ can be your backup.        |  Newtown Square, Pennsylvania 19073

In response to

pgsql-docs by date

Next:From: Peter EisentrautDate: 2005-09-29 06:38:47
Subject: Re: Added documentation about caching, reliability
Previous:From: Alvaro HerreraDate: 2005-09-29 02:23:49
Subject: Re: Added documentation about caching, reliability

pgsql-hackers by date

Next:From: Tom LaneDate: 2005-09-29 02:33:41
Subject: Re: [PATCHES] Proposed patch for sequence-renaming problems
Previous:From: Alvaro HerreraDate: 2005-09-29 02:23:49
Subject: Re: Added documentation about caching, reliability

Privacy Policy | About PostgreSQL
Copyright © 1996-2014 The PostgreSQL Global Development Group