pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: Daniel Gustafsson <daniel@yesql.se>
To: pgsql-docs@postgresql.org
Subject: Wording in Error Message Style Guide
Date: Fri, 15 Jul 2016 11:20:27 +0200
Message-ID: <48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se> (raw)
List-Unsubscribe: <mailto:majordomo@postgresql.org?body=unsub%20pgsql-docs>

Perhaps a nitpick, but in subsection 51.3.1 in the "Error Message Style Guide"
the language in the rationale for avoiding implementation details seems to not
be in line with the overall one of voice of the docs.  ISTM the following reads
better:

-    don't know the details anyway.
+    aren't expected to know the details.

Patch attached.

cheers ./daniel

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

Attachments:

error_message_style_guide.diff (application/octet-stream, 538B) download diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml index 13409a7..1642232 100644 --- a/doc/src/sgml/sources.sgml +++ b/doc/src/sgml/sources.sgml @@ -453,7 +453,7 @@ Hint: the addendum verbose mode, or perhaps a pop-up error-details window. Also, details and hints would normally be suppressed from the server log to save space. Reference to implementation details is best avoided since users - don't know the details anyway. + aren't expected to know the details. </para> </simplesect>

view thread (2+ messages)  latest in thread

Message-ID: <48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se>
Permalink:  ../48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se/
Also on:    postgresql.org/message-id/48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se

 ·  · 

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 from your mail client; the link fills in
  the headers below: reply via email
  Some clients, webmail especially, drop In-Reply-To and References from
  a link, and the reply then starts a new thread: use the mbox below.

  To: pgsql-docs@postgresql.org
  Cc: daniel@yesql.se
  Subject: Re: Wording in Error Message Style Guide
  In-Reply-To: <48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se>
  References: <48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se>

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

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