Received: from malur.postgresql.org ([217.196.149.56]) by arkaria.postgresql.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bNzIR-0006mD-IO for pgsql-docs@arkaria.postgresql.org; Fri, 15 Jul 2016 09:20:35 +0000 Received: from localhost ([127.0.0.1] helo=postgresql.org) by malur.postgresql.org with smtp (Exim 4.84_2) (envelope-from ) id 1bNzIQ-0007lo-FT for pgsql-docs@arkaria.postgresql.org; Fri, 15 Jul 2016 09:20:34 +0000 Received: from magus.postgresql.org ([2a02:c0:301:0:ffff::29]) by malur.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1bNzIP-0007lK-Pg for pgsql-docs@postgresql.org; Fri, 15 Jul 2016 09:20:33 +0000 Received: from mail-lf0-x22a.google.com ([2a00:1450:4010:c07::22a]) by magus.postgresql.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.84_2) (envelope-from ) id 1bNzIM-0005DA-Uc for pgsql-docs@postgresql.org; Fri, 15 Jul 2016 09:20:33 +0000 Received: by mail-lf0-x22a.google.com with SMTP id f93so83467408lfi.2 for ; Fri, 15 Jul 2016 02:20:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=sender:from:subject:message-id:date:to:mime-version; bh=JKpGM4D0RVdn69O2DX+34mu63qwK61E4yMrfKmbsDnw=; b=dLqUPoFwAMk68ER5DDeWcDZlBDEFaSdabX1cRLlMThBCgtFD51GbpF82eNtXyU5+le QPvpn6DrYqrt6Js7f47Ay9ceKfhJMzw3uaBzPvgBVsz47xV3jDn/yQGMqdGvYKCZKfIr H85wLd86imFIPBDePd1fQElaXoObXol1Aw+croagsWEJTlLXEe27U0EytARV90Z+wANX jaJT4sHSEKQcG5K+TfIJtOPMKCjBM4G1cspsB3bg5DmhyrP8xwddi9x7zLNdj0OUWIdZ r8Kj9mrMidUpiw9b2LlQA2GI0ZScZHppGO2jFhrDoaBGuaoD6yqsh5F69YnwbjX51kdn m7GA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:sender:from:subject:message-id:date:to :mime-version; bh=JKpGM4D0RVdn69O2DX+34mu63qwK61E4yMrfKmbsDnw=; b=lsc4zR3OV+3PNYKkIxAyP8UmS/mOP04ErC1ibQoYgRP0HSgFZW1bkby8AJ4+DTbNR9 f5wxpkvr1yLuNuIDgRGXi9S18tbouQilBzt8UHnMgEGXtOk9xp1aEZh/rhlmuXFzGzgo 8fit3fsfmkGhBM3pQrfYI9m1F8DehnwRvzEhCsvuoEBrExk5xSSdXnhSogcms5j6EzhQ NzHGUdD+Ovl49XPR4WDmNw+7S1gX9c5+z0E7o2sJVL4SZX2/DXiD4oSbAMY+y7WSERNJ L7LZ+96vzoopboyY3piWzT1M/8dOrN3UNE5CthLMhi4I2dBForz+Chu2zoO1mcTn2zXW L3rw== X-Gm-Message-State: ALyK8tK54FXT3plEgCkruCAGfpGurJV26nTM8ov3lc5zB3nL8YvVfYhkjCkcfC2mRVAAxQ== X-Received: by 10.25.25.137 with SMTP id 131mr10965110lfz.149.1468574429089; Fri, 15 Jul 2016 02:20:29 -0700 (PDT) Received: from [192.168.1.65] (c-0c22e455.027-294-73746f71.cust.bredbandsbolaget.se. [85.228.34.12]) by smtp.gmail.com with ESMTPSA id u70sm1704263lja.15.2016.07.15.02.20.28 for (version=TLS1 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Fri, 15 Jul 2016 02:20:28 -0700 (PDT) From: Daniel Gustafsson Content-Type: multipart/mixed; boundary="Apple-Mail=_5C52C8ED-F09A-40A8-9D54-8CB720376F0F" Subject: Wording in Error Message Style Guide Message-Id: <48DB4EDA-96F8-4B2F-99C4-110900FC7540@yesql.se> Date: Fri, 15 Jul 2016 11:20:27 +0200 To: pgsql-docs@postgresql.org Mime-Version: 1.0 (Mac OS X Mail 9.3 \(3124\)) X-Mailer: Apple Mail (2.3124) X-Pg-Spam-Score: -2.6 (--) List-Archive: List-Help: List-ID: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: X-Mailing-List: pgsql-docs Precedence: bulk Sender: pgsql-docs-owner@postgresql.org --Apple-Mail=_5C52C8ED-F09A-40A8-9D54-8CB720376F0F Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=us-ascii Perhaps a nitpick, but in subsection 51.3.1 in the "Error Message Style Gui= de" 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 r= eads better: - don't know the details anyway. + aren't expected to know the details. Patch attached. cheers ./daniel --Apple-Mail=_5C52C8ED-F09A-40A8-9D54-8CB720376F0F Content-Disposition: attachment; filename=error_message_style_guide.diff Content-Type: application/octet-stream; name="error_message_style_guide.diff" Content-Transfer-Encoding: 7bit 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. --Apple-Mail=_5C52C8ED-F09A-40A8-9D54-8CB720376F0F Content-Type: text/plain Content-Disposition: inline Content-Transfer-Encoding: 8bit MIME-Version: 1.0 -- Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org) To make changes to your subscription: http://www.postgresql.org/mailpref/pgsql-docs --Apple-Mail=_5C52C8ED-F09A-40A8-9D54-8CB720376F0F--