Thread

1. libpq documentation cleanups (repost 3)

   Bruce Momjian <bruce@momjian.us> — 2011-01-12T16:53:04Z

   The attached patch is a collection of libpq documentation cleanups
   recommended in a list of changes emailed to me by Leslie S Satenstein.
   
   Leslie found a number of places our libpq documentation that were unclear
   or awkward, and this diff generated by me attempts to address them.
   
   I have already updated the documentation proofreading wiki:
   
   	http://wiki.postgresql.org/wiki/Documentation_Proofreading
   
   -- 
     Bruce Momjian  <bruce@momjian.us>        http://momjian.us
     EnterpriseDB                             http://enterprisedb.com
   
     + It's impossible for everything to be true. +
   

2. Re: libpq documentation cleanups (repost 3)

   Robert Haas <robertmhaas@gmail.com> — 2011-01-12T17:04:40Z

   On Wed, Jan 12, 2011 at 11:53 AM, Bruce Momjian <bruce@momjian.us> wrote:
   > The attached patch is a collection of libpq documentation cleanups
   > recommended in a list of changes emailed to me by Leslie S Satenstein.
   >
   > Leslie found a number of places our libpq documentation that were unclear
   > or awkward, and this diff generated by me attempts to address them.
   >
   > I have already updated the documentation proofreading wiki:
   >
   >        http://wiki.postgresql.org/wiki/Documentation_Proofreading
   
   I don't think changing "see below" to "refer below" or "call" to
   "execute" is an improvement; even if we did that uniformly throughout
   our documentation, surely future editors are going to reuse those
   phrasings.
   
   A lot of these other changes look pretty dubious too, although some
   seem worthwhile.
   
   -- 
   Robert Haas
   EnterpriseDB: http://www.enterprisedb.com
   The Enterprise PostgreSQL Company
   
   

3. Re: libpq documentation cleanups (repost 3)

   Dmitry Igrishin <dmitigr@gmail.com> — 2011-01-12T17:25:53Z

   2011/1/12 Robert Haas <robertmhaas@gmail.com>
   
   > On Wed, Jan 12, 2011 at 11:53 AM, Bruce Momjian <bruce@momjian.us> wrote:
   > > The attached patch is a collection of libpq documentation cleanups
   > > recommended in a list of changes emailed to me by Leslie S Satenstein.
   > >
   > > Leslie found a number of places our libpq documentation that were unclear
   > > or awkward, and this diff generated by me attempts to address them.
   > >
   > > I have already updated the documentation proofreading wiki:
   > >
   > >        http://wiki.postgresql.org/wiki/Documentation_Proofreading
   >
   > I don't think changing "see below" to "refer below" or "call" to
   > "execute" is an improvement; even if we did that uniformly throughout
   > our documentation, surely future editors are going to reuse those
   > phrasings.
   >
   > A lot of these other changes look pretty dubious too, although some
   > seem worthwhile.
   >
   I propose to change "backend server" to "backend" or "server.
   Robert, you mentioned that "backend server" phrase is suggest
   interchangeability of "backend" or "server" but there is no term
   "backend server".
   
   >
   > --
   > Robert Haas
   > EnterpriseDB: http://www.enterprisedb.com
   > The Enterprise PostgreSQL Company
   >
   > --
   > Sent via pgsql-hackers mailing list (pgsql-hackers@postgresql.org)
   > To make changes to your subscription:
   > http://www.postgresql.org/mailpref/pgsql-hackers
   >
   
   
   
   -- 
   // Dmitriy.
   

4. Re: libpq documentation cleanups (repost 3)

   Bruce Momjian <bruce@momjian.us> — 2011-01-12T17:46:40Z

   Robert Haas wrote:
   > On Wed, Jan 12, 2011 at 11:53 AM, Bruce Momjian <bruce@momjian.us> wrote:
   > > The attached patch is a collection of libpq documentation cleanups
   > > recommended in a list of changes emailed to me by Leslie S Satenstein.
   > >
   > > Leslie found a number of places our libpq documentation that were unclear
   > > or awkward, and this diff generated by me attempts to address them.
   > >
   > > I have already updated the documentation proofreading wiki:
   > >
   > > ? ? ? ?http://wiki.postgresql.org/wiki/Documentation_Proofreading
   > 
   > I don't think changing "see below" to "refer below" or "call" to
   > "execute" is an improvement; even if we did that uniformly throughout
   > our documentation, surely future editors are going to reuse those
   > phrasings.
   > 
   > A lot of these other changes look pretty dubious too, although some
   > seem worthwhile.
   
   OK, that last part seems kind of vague.  ;-)  Can you hack up the diff
   to have just the changes you think are worthwhile?  You can just remove
   the parts of the diff you don't like.
   
   -- 
     Bruce Momjian  <bruce@momjian.us>        http://momjian.us
     EnterpriseDB                             http://enterprisedb.com
   
     + It's impossible for everything to be true. +
   
   

5. Re: libpq documentation cleanups (repost 3)

   Bruce Momjian <bruce@momjian.us> — 2011-01-12T18:12:48Z

   Bruce Momjian wrote:
   > Robert Haas wrote:
   > > On Wed, Jan 12, 2011 at 11:53 AM, Bruce Momjian <bruce@momjian.us> wrote:
   > > > The attached patch is a collection of libpq documentation cleanups
   > > > recommended in a list of changes emailed to me by Leslie S Satenstein.
   > > >
   > > > Leslie found a number of places our libpq documentation that were unclear
   > > > or awkward, and this diff generated by me attempts to address them.
   > > >
   > > > I have already updated the documentation proofreading wiki:
   > > >
   > > > ? ? ? ?http://wiki.postgresql.org/wiki/Documentation_Proofreading
   > > 
   > > I don't think changing "see below" to "refer below" or "call" to
   > > "execute" is an improvement; even if we did that uniformly throughout
   > > our documentation, surely future editors are going to reuse those
   > > phrasings.
   > > 
   > > A lot of these other changes look pretty dubious too, although some
   > > seem worthwhile.
   > 
   > OK, that last part seems kind of vague.  ;-)  Can you hack up the diff
   > to have just the changes you think are worthwhile?  You can just remove
   > the parts of the diff you don't like.
   
   Robert, here is a unified diff, which I think it easier to review for
   single-line documention changes.
   
   -- 
     Bruce Momjian  <bruce@momjian.us>        http://momjian.us
     EnterpriseDB                             http://enterprisedb.com
   
     + It's impossible for everything to be true. +
   

6. Re: libpq documentation cleanups (repost 3)

   Peter Eisentraut <peter_e@gmx.net> — 2011-01-12T21:05:12Z

   On ons, 2011-01-12 at 12:04 -0500, Robert Haas wrote:
   > On Wed, Jan 12, 2011 at 11:53 AM, Bruce Momjian <bruce@momjian.us> wrote:
   > > The attached patch is a collection of libpq documentation cleanups
   > > recommended in a list of changes emailed to me by Leslie S Satenstein.
   > >
   > > Leslie found a number of places our libpq documentation that were unclear
   > > or awkward, and this diff generated by me attempts to address them.
   > >
   > > I have already updated the documentation proofreading wiki:
   > >
   > >        http://wiki.postgresql.org/wiki/Documentation_Proofreading
   > 
   > I don't think changing "see below" to "refer below" or "call" to
   > "execute" is an improvement; even if we did that uniformly throughout
   > our documentation, surely future editors are going to reuse those
   > phrasings.
   
   Agreed.
   
   > A lot of these other changes look pretty dubious too, although some
   > seem worthwhile.
   
   Agreed. :-/