Re: per feedback I received directly, pg_dump manpage patch

From: Peter Eisentraut <peter_e(at)gmx(dot)net>
To: Alvaro Herrera <alvherre(at)2ndquadrant(dot)com>, "Joshua D(dot) Drake" <jd(at)commandprompt(dot)com>
Cc: pgsql-docs <pgsql-docs(at)postgresql(dot)org>
Subject: Re: per feedback I received directly, pg_dump manpage patch
Date: 2015-05-28 18:18:49
Message-ID: 55675C09.7050205@gmx.net
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

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.

In response to

Browse pgsql-docs by date

  From Date Subject
Next Message Joshua D. Drake 2015-05-28 19:27:05 Re: per feedback I received directly, pg_dump manpage patch
Previous Message Peter Eisentraut 2015-05-28 18:16:33 Re: per feedback I received directly, pg_dump manpage patch