Thread: Hint and detail punctuation

Hint and detail punctuation

From
Daniel Gustafsson
Date:
While looking at error messages downstream, I noticed a few hints and details
in postgres which aren’t punctuated as per the style guide.  The attached patch
fixes the ones where it seemed reasonable to end with a period.

cheers ./daniel


Attachment

Re: Hint and detail punctuation

From
Michael Paquier
Date:
On Wed, Dec 05, 2018 at 05:22:25PM +0100, Daniel Gustafsson wrote:
> While looking at error messages downstream, I noticed a few hints and details
> in postgres which aren’t punctuated as per the style guide.  The attached patch
> fixes the ones where it seemed reasonable to end with a period.

Good point.  I am spotting a couple more places:
src/backend/utils/misc/guc.c:
GUC_check_errdetail("effective_io_concurrency must be set to 0 on
platforms that lack posix_fadvise()");
src/backend/utils/misc/guc.c:
GUC_check_errdetail("recovery_target_timeline is not a valid number");
src/backend/utils/misc/guc.c:
GUC_check_errdetail("recovery_target_name is too long (maximum %d
characters)",

Thanks,
--
Michael

Attachment

Re: Hint and detail punctuation

From
Daniel Gustafsson
Date:
> On 6 Dec 2018, at 05:46, Michael Paquier <michael@paquier.xyz> wrote:
>
> On Wed, Dec 05, 2018 at 05:22:25PM +0100, Daniel Gustafsson wrote:
>> While looking at error messages downstream, I noticed a few hints and details
>> in postgres which aren’t punctuated as per the style guide.  The attached patch
>> fixes the ones where it seemed reasonable to end with a period.
>
> Good point.  I am spotting a couple more places:
> src/backend/utils/misc/guc.c:

Ah, for some reason I hadn’t thought about looking at the GUCs.  I agree with
your findings, patch updated.

cheers ./daniel


Attachment

Re: Hint and detail punctuation

From
Michael Paquier
Date:
On Thu, Dec 06, 2018 at 09:42:26AM +0100, Daniel Gustafsson wrote:
> Ah, for some reason I hadn’t thought about looking at the GUCs.  I agree with
> your findings, patch updated.

Thanks Daniel, that looks fine to me at quick glance.  I'll try to get
that committed tomorrow my time if there are no objections until then.
--
Michael

Attachment

Re: Hint and detail punctuation

From
Alvaro Herrera
Date:
On 2018-Dec-06, Daniel Gustafsson wrote:

> > On 6 Dec 2018, at 05:46, Michael Paquier <michael@paquier.xyz> wrote:
> > 
> > On Wed, Dec 05, 2018 at 05:22:25PM +0100, Daniel Gustafsson wrote:
> >> While looking at error messages downstream, I noticed a few hints and details
> >> in postgres which aren’t punctuated as per the style guide.  The attached patch
> >> fixes the ones where it seemed reasonable to end with a period.
> > 
> > Good point.  I am spotting a couple more places:
> > src/backend/utils/misc/guc.c:
> 
> Ah, for some reason I hadn’t thought about looking at the GUCs.  I agree with
> your findings, patch updated.

LGTM.


-- 
Álvaro Herrera                https://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services


Re: Hint and detail punctuation

From
Michael Paquier
Date:
On Thu, Dec 06, 2018 at 09:44:22AM -0300, Alvaro Herrera wrote:
> LGTM.

Thanks Álvaro for the additional lookup.  I have committed the patch,
after updating the regression test output as this stuff was forgotten,
but that was easy enough to fix.
--
Michael

Attachment

Re: Hint and detail punctuation

From
Daniel Gustafsson
Date:
> On 6 Dec 2018, at 23:51, Michael Paquier <michael@paquier.xyz> wrote:
>
> On Thu, Dec 06, 2018 at 09:44:22AM -0300, Alvaro Herrera wrote:
>> LGTM.
>
> Thanks Álvaro for the additional lookup.  I have committed the patch,
> after updating the regression test output as this stuff was forgotten,
> but that was easy enough to fix.

Oh..  sorry about that, I should’ve known better.  Thanks for tidying up!

cheers ./daniel

Re: Hint and detail punctuation

From
Michael Paquier
Date:
On Fri, Dec 07, 2018 at 01:27:52AM +0100, Daniel Gustafsson wrote:
> Oh..  sorry about that, I should’ve known better.  Thanks for tidying up!

No problem.  Thanks for the report and for caring on the matter.  So do
I.
--
Michael

Attachment

Re: Hint and detail punctuation

From
Bruce Momjian
Date:
On Wed, Dec  5, 2018 at 05:22:25PM +0100, Daniel Gustafsson wrote:
> While looking at error messages downstream, I noticed a few hints and details
> in postgres which aren’t punctuated as per the style guide.  The attached patch
> fixes the ones where it seemed reasonable to end with a period.

FYI, this was applied:

    commit 730422afcdb6784bbe20efc65de72156d470b0c4
    Author: Michael Paquier <michael@paquier.xyz>
    Date:   Fri Dec 7 07:47:42 2018 +0900
    
        Fix some errhint and errdetail strings missing a period
    
        As per the error message style guide of the documentation, those should
        be full sentences.
    
        Author: Daniel Gustafsson
        Reviewed-by: Michael Paquier, Álvaro Herrera
        Discussion: https://1E8D49B4-16BC-4420-B4ED-58501D9E076B@yesql.se

-- 
  Bruce Momjian  <bruce@momjian.us>        http://momjian.us
  EnterpriseDB                             http://enterprisedb.com

+ As you are, so once was I.  As I am, so you will be. +
+                      Ancient Roman grave inscription +