public inbox for [email protected]  
help / color / mirror / Atom feed
From: Josh Berkus <[email protected]>
To: Tom Lane <[email protected]>
To: [email protected]
Subject: Re: Do we need "Diagnostics" sections of SQL command reference pages?
Date: Wed, 3 Sep 2003 13:06:14 -0700
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>
References: <[email protected]>

Tom,

> I'm starting to look at updating the docs to match 7.4 error message
> spellings.  I find that a large part of the work I'll have to do is in
> updating the "Diagnostics" (formerly "Outputs") section of the command
> reference pages.  I am wondering if it wouldn't be better to just rip
> out these sections entirely.  They seem like nearly content-free fluff
> to me --- the listings of possible error messages are always incomplete,
> often out of date, and arguably useless.  If there is an error message
> that's not clear enough by itself, we'd better fix the error message
> instead of putting a gloss on it in the reference page.
> 
> Comments?

I agree that we don't need descriptions of the meaning of each error message 
in the command documentation.

However, the listing of potential error messages is *very* useful to 
application coders for doing automated handling of errors.   Since we are now 
supporting SQLSTATE responses, perhaps we could have error code ranges for 
the commands?     Or is that totally unreasonable?


-- 
-Josh Berkus
 Aglio Database Solutions
 San Francisco




view thread (12+ messages)  latest in thread

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: [email protected]
  Cc: [email protected], [email protected]
  Subject: Re: Do we need "Diagnostics" sections of SQL command reference pages?
  In-Reply-To: <[email protected]>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox