public inbox for [email protected]
help / color / mirror / Atom feedtypo in doc for "Miscellaneous Coding Conventions"
4+ messages / 4 participants
[nested] [flat]
* typo in doc for "Miscellaneous Coding Conventions"
@ 2021-05-18 05:14 PG Doc comments form <[email protected]>
2021-05-18 13:52 ` Re: typo in doc for "Miscellaneous Coding Conventions" Tom Lane <[email protected]>
0 siblings, 1 reply; 4+ messages in thread
From: PG Doc comments form @ 2021-05-18 05:14 UTC (permalink / raw)
To: [email protected]; +Cc: [email protected]
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/13/source-conventions.html
Description:
small fix in description at [1] as follows
-If that were not done interrupted code that's currently inspecting errno
might see the wrong value.
+If that was not done interrupted code that's currently inspecting errno
might see the wrong value.
[1]https://www.postgresql.org/docs/devel/source-conventions.html
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: typo in doc for "Miscellaneous Coding Conventions"
2021-05-18 05:14 typo in doc for "Miscellaneous Coding Conventions" PG Doc comments form <[email protected]>
@ 2021-05-18 13:52 ` Tom Lane <[email protected]>
2021-05-18 16:26 ` Re: typo in doc for "Miscellaneous Coding Conventions" Bryn Llewellyn <[email protected]>
0 siblings, 1 reply; 4+ messages in thread
From: Tom Lane @ 2021-05-18 13:52 UTC (permalink / raw)
To: [email protected]; +Cc: [email protected]
PG Doc comments form <[email protected]> writes:
> small fix in description at [1] as follows
> -If that were not done interrupted code that's currently inspecting errno
> might see the wrong value.
> +If that was not done interrupted code that's currently inspecting errno
> might see the wrong value.
The existing text is perfectly good English; your change
makes it less so. I'm afraid it's been too many years since
high school English for me to remember the exact grammatical
term for this, but "were not" is typical usage when stating
a contrary-to-fact hypothetical.
regards, tom lane
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: typo in doc for "Miscellaneous Coding Conventions"
2021-05-18 05:14 typo in doc for "Miscellaneous Coding Conventions" PG Doc comments form <[email protected]>
2021-05-18 13:52 ` Re: typo in doc for "Miscellaneous Coding Conventions" Tom Lane <[email protected]>
@ 2021-05-18 16:26 ` Bryn Llewellyn <[email protected]>
2021-05-19 01:09 ` RE: typo in doc for "Miscellaneous Coding Conventions" [email protected] <[email protected]>
0 siblings, 1 reply; 4+ messages in thread
From: Bryn Llewellyn @ 2021-05-18 16:26 UTC (permalink / raw)
To: Tom Lane PostgreSQL <[email protected]>; [email protected]; +Cc: Pg Docs <[email protected]>
[email protected] wrote:
> PG Doc comments form writes:
>
>> small fix in description at [1] as follows
>
>> -If that were not done interrupted code that's currently inspecting errno
>> might see the wrong value.
>> +If that was not done interrupted code that's currently inspecting errno
>> might see the wrong value.
>
> The existing text is perfectly good English; your change
> makes it less so. I'm afraid it's been too many years since
> high school English for me to remember the exact grammatical
> term for this, but "were not" is typical usage when stating
> a contrary-to-fact hypothetical.
(1) “IF bla bla… <comma> THEN bla bla…”
It might be more words than the bare minimum. But it helps the user separate out the proposition and the consequence.
(2) This is the dreaded curse of the passive voice (“mistakes were made”). There are many cases where an active formulation is nicer. Anyway, you can sidestep lots of the conundrums, like the alternatives here pose, by standing back and finding a different way to make the point.
> If the implementation (or you) didn’t do X, then Y bad thing could happen.
^ permalink raw reply [nested|flat] 4+ messages in thread
* RE: typo in doc for "Miscellaneous Coding Conventions"
2021-05-18 05:14 typo in doc for "Miscellaneous Coding Conventions" PG Doc comments form <[email protected]>
2021-05-18 13:52 ` Re: typo in doc for "Miscellaneous Coding Conventions" Tom Lane <[email protected]>
2021-05-18 16:26 ` Re: typo in doc for "Miscellaneous Coding Conventions" Bryn Llewellyn <[email protected]>
@ 2021-05-19 01:09 ` [email protected] <[email protected]>
0 siblings, 0 replies; 4+ messages in thread
From: [email protected] @ 2021-05-19 01:09 UTC (permalink / raw)
To: Bryn Llewellyn <[email protected]>; Tom Lane PostgreSQL <[email protected]>; +Cc: Pg Docs <[email protected]>
>"were not" is typical usage when stating a contrary-to-fact hypothetical.
> If the implementation (or you) didn’t do X, then Y bad thing could happen.
Really thanks for your kindly reply and explain.
Please forgive me for my poor English. Anyway, got it.
Regards,
Tang
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2021-05-19 01:09 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2021-05-18 05:14 typo in doc for "Miscellaneous Coding Conventions" PG Doc comments form <[email protected]>
2021-05-18 13:52 ` Tom Lane <[email protected]>
2021-05-18 16:26 ` Bryn Llewellyn <[email protected]>
2021-05-19 01:09 ` [email protected] <[email protected]>
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox