[DOCS] Grammar and formatting errors for 9.02 pdf version

2010-12-21 Thread Leslie S Satenstein
I have been reviewing the documentation and in particular chapter 31.  I found 
quite a few grammar and formatting errors which make for a lot of head 
scratching about what to do.

Are there any groups working on fixing up the doc?  Is there a desire to just 
leave it as is?


--

Regards  
 Leslie
 Mr. Leslie Satenstein

 
mailto:[email protected]
mailto [email protected] / [email protected]
www.itbms.biz
 

Re: [DOCS] Grammar and formatting errors for 9.02 pdf version

2010-12-21 Thread Robert Haas
On Tue, Dec 21, 2010 at 6:19 PM, Leslie S Satenstein
 wrote:
> I have been reviewing the documentation and in particular chapter 31.  I 
> found quite a few grammar and formatting errors which make for a lot of head 
> scratching about what to do.
>
> Are there any groups working on fixing up the doc?  Is there a desire to just 
> leave it as is?

We're always interested in making improvements to the documentation,
and certainly any grammatical errors should be fixed.  You'll have to
tell us what you think they are, though, or better yet provide a
patch.

With respect to formatting errors, we tend to worry more about the
HTML versions of the docs than the PDF.  However, you should certainly
point out what you have noticed so that we can try to determine
whether anything can be done to improve the situation.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

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


Re: [DOCS] Grammar and formatting errors for 9.02 pdf version

2010-12-21 Thread Robert Haas
On Tue, Dec 21, 2010 at 10:43 PM, Leslie S Satenstein
 wrote:
>
> Hi Robert, I am not familiar with your patch process.  However, I can copy 
> and paste the offending lines in the PDF file, to a word or openoffice 
> document, and use green for insert and red text for delete.  As well as 
> identifying the page.
>
> Some text, if rephrased, makes the meaning more clear. Some text has missing 
> nouns and where several nouns preceed a pronoun,  it causes a delay as one 
> analyzes the sentence to extract the author's meaning.
>
> If there is a better way, please advise me.

Please keep replies on-list, and write your replies beneath the quoted
text rather than above it.

To submit a patch, you need to check out the source code, edit the
SGML documentation, and then use git diff.  See:

http://wiki.postgresql.org/wiki/Submitting_a_Patch

In short:

git clone git://git.postgresql.org/git/postgresql.git

git diff > grammar.patch


If you have only a handful of changes, feel free to just point out the
parts that you think could be phrased better and how you think they
should be written, rather than generating a patch.  Actually, it'd
probably be better to point out the first few changes that way anyhow,
to see if we agree with your opinions on what should be done.  If
you're submitting a large number of edits, you're going to have to
learn how to generate a patch file as per the above, because otherwise
it's going to be extremely laborious for anyone to think about
applying your changes.

--
Robert Haas
EnterpriseDB: http://www.enterprisedb.com
The Enterprise PostgreSQL Company

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