Re: assorted documentation errors

From: Bruce Momjian <pgman(at)candle(dot)pha(dot)pa(dot)us>
To: Rich Morin <rdm(at)cfcl(dot)com>
Cc: pgsql-bugs(at)postgresql(dot)org
Subject: Re: assorted documentation errors
Date: 2001-08-13 15:23:04
Message-ID: 200108131523.f7DFN4d15770@candle.pha.pa.us
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-bugs

> I have been looking over the PostgreSQL manual pages and have noted a
> number of formatting problems. Unfortunately, as the DocBook source
> code does not seem to be in the distribution, I have no way of knowing
> where these problems originated. In any case, here is a summary:
>
> createdb.1, createlang.1, createuser.1, dropdb.1, droplang.1, etc.
>
> In many places where code and output examples are being given, the
> font used is proportional. If a monospace font were used, the code
> would stand out better and the output would line up correctly.

Looks fine at:

http://www.ca.postgresql.org/devel-corner/docs/postgres/app-createdb.html

Do you see the problem there?

> droplang.1, dropuser.1, etc.
>
> There is insufficient consistentcy to the NAME entries. For instance:
>
> droplang - Remove a programming language from a Postgres database
> dropuser - Drops (removes) a Postgres user
>
> Why not settle on either "Removes/Drops" or "Remove/Drop"?

Agreed.

> pg_restore.1
>
> In the NAME entry, there is a missing space in "created bypg_dump".

I don't see that problem here.

> alter_group.l
>
> In the NAME entry, the comma should be a semi-colon: "group; remove".

Agreed.

> fetch.l
>
> In the NAME entry, there should be a comma: "rows, using".

I don't agree on the use of the comma here.

Patch attached and applied.

--
Bruce Momjian | http://candle.pha.pa.us
pgman(at)candle(dot)pha(dot)pa(dot)us | (610) 853-3000
+ If your life is a hard drive, | 830 Blythe Avenue
+ Christ can be your backup. | Drexel Hill, Pennsylvania 19026

Attachment Content-Type Size
unknown_filename text/plain 9.5 KB

In response to

Responses

Browse pgsql-bugs by date

  From Date Subject
Next Message Bruce Momjian 2001-08-13 16:14:03 Re: assorted documentation errors
Previous Message root 2001-08-13 15:10:10 WAL couse die my database?