Message-ID: <55675C09.7050205@gmx.net>
Date: Thu, 28 May 2015 14:18:49 -0400
From: Peter Eisentraut <peter_e@gmx.net>
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.10;
 rv:31.0) Gecko/20100101 Thunderbird/31.7.0
MIME-Version: 1.0
To: Alvaro Herrera <alvherre@2ndquadrant.com>,
 "Joshua D. Drake" <jd@commandprompt.com>
CC: pgsql-docs <pgsql-docs@postgresql.org>
Subject: Re: per feedback I received directly, pg_dump manpage patch
References: <55665072.9020409@commandprompt.com>
 <20150528013101.GG5885@postgresql.org>
In-Reply-To: <20150528013101.GG5885@postgresql.org>
Content-Type: text/plain; charset=windows-1252
Content-Transfer-Encoding: 7bit
Precedence: bulk
Sender: pgsql-docs-owner@postgresql.org

On 5/27/15 9:31 PM, Alvaro Herrera wrote:
> I didn't check the location of the warning in your patch, or whether a
> warning is really appropriate rather than, say, <note> or a plain
> <para>.

The problem is that every time we get a bug report that some user
tripped over something that was not clear in the documentation, the
patch wants to add a note or warning, which causes some parts of the
documentation to degrade into just a series of warning boxes.  The fewer
warning boxes there are, however, the more likely the user will actually
read all of the documentation, I think.


-- 
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs