Background worker docs,

Started by Dave Cramerover 4 years ago11 messagesdocs
Jump to latest
#1Dave Cramer
pg@fastcrypt.com

Why is the last comma there ?

"bgw_restart_time is the interval, in seconds, that postgres should wait
before restarting the process, in case it crashes."

diff --git a/doc/src/sgml/bgworker.sgml b/doc/src/sgml/bgworker.sgml
index d34acfc220..6f13006e25 100644
--- a/doc/src/sgml/bgworker.sgml
+++ b/doc/src/sgml/bgworker.sgml
@@ -130,7 +130,7 @@ typedef struct BackgroundWorker
   <para>
    <structfield>bgw_restart_time</structfield> is the interval, in
seconds, that
-   <command>postgres</command> should wait before restarting the process,
in
+   <command>postgres</command> should wait before restarting the process in
    case it crashes.  It can be any positive value,
    or <literal>BGW_NEVER_RESTART</literal>, indicating not to restart the
    process in case of a crash.

Dave Cramer

#2Daniel Gustafsson
daniel@yesql.se
In reply to: Dave Cramer (#1)
Re: Background worker docs,

On 27 Aug 2021, at 15:17, Dave Cramer <davecramer@gmail.com> wrote:

Why is the last comma there ?

"bgw_restart_time is the interval, in seconds, that postgres should wait before restarting the process, in case it crashes."

-   <command>postgres</command> should wait before restarting the process, in
+   <command>postgres</command> should wait before restarting the process in

While not being an native english speaker, I agree that this reads better.

--
Daniel Gustafsson https://vmware.com/

#3Dave Cramer
pg@fastcrypt.com
In reply to: Daniel Gustafsson (#2)
Re: Background worker docs,

On Fri, 27 Aug 2021 at 09:24, Daniel Gustafsson <daniel@yesql.se> wrote:

On 27 Aug 2021, at 15:17, Dave Cramer <davecramer@gmail.com> wrote:

Why is the last comma there ?

"bgw_restart_time is the interval, in seconds, that postgres should wait

before restarting the process, in case it crashes."

- <command>postgres</command> should wait before restarting the

process, in

+ <command>postgres</command> should wait before restarting the

process in

While not being an native english speaker, I agree that this reads better.

As a native English speaker, I was left wondering what else the timeout
would be used for.

Dave Cramer

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Dave Cramer (#3)
Re: Background worker docs,

Dave Cramer <davecramer@gmail.com> writes:

-   <command>postgres</command> should wait before restarting the
process, in
+   <command>postgres</command> should wait before restarting the
process in

As a native English speaker, I was left wondering what else the timeout
would be used for.

Maybe s/in case/if/ ? Or s/in case/after/ ? It does seem like this
sentence needs more help than just comma-removal.

regards, tom lane

#5Dave Cramer
pg@fastcrypt.com
In reply to: Tom Lane (#4)
Re: Background worker docs,

On Fri, 27 Aug 2021 at 09:50, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Dave Cramer <davecramer@gmail.com> writes:

-   <command>postgres</command> should wait before restarting the
process, in
+   <command>postgres</command> should wait before restarting the
process in

As a native English speaker, I was left wondering what else the timeout
would be used for.

Maybe s/in case/if/ ? Or s/in case/after/ ? It does seem like this
sentence needs more help than just comma-removal.

In my mind "in the event that it crashes" made it clear

Show quoted text

regards, tom lane

#6Daniel Gustafsson
daniel@yesql.se
In reply to: Dave Cramer (#5)
Re: Background worker docs,

On 27 Aug 2021, at 15:52, Dave Cramer <davecramer@gmail.com> wrote:
On Fri, 27 Aug 2021 at 09:50, Tom Lane <tgl@sss.pgh.pa.us <mailto:tgl@sss.pgh.pa.us>> wrote:

Maybe s/in case/if/ ? Or s/in case/after/ ? It does seem like this
sentence needs more help than just comma-removal.

In my mind "in the event that it crashes" made it clear

That, or “if it crashes” gets my vote.

--
Daniel Gustafsson https://vmware.com/

#7Tom Lane
tgl@sss.pgh.pa.us
In reply to: Daniel Gustafsson (#6)
Re: Background worker docs,

Daniel Gustafsson <daniel@yesql.se> writes:

On 27 Aug 2021, at 15:52, Dave Cramer <davecramer@gmail.com> wrote:

In my mind "in the event that it crashes" made it clear

That, or “if it crashes” gets my vote.

Dave's wording sounds good to me.

regards, tom lane

#8Dave Cramer
pg@fastcrypt.com
In reply to: Tom Lane (#7)
Re: Background worker docs,

On Fri, 27 Aug 2021 at 10:15, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Show quoted text

Daniel Gustafsson <daniel@yesql.se> writes:

On 27 Aug 2021, at 15:52, Dave Cramer <davecramer@gmail.com> wrote:

In my mind "in the event that it crashes" made it clear

That, or “if it crashes” gets my vote.

Dave's wording sounds good to me.

regards, tom lane

revised diff

Attachments:

bgworker_docs.patchapplication/octet-stream; name=bgworker_docs.patchDownload+2-2
#9Daniel Gustafsson
daniel@yesql.se
In reply to: Tom Lane (#7)
Re: Background worker docs,

On 27 Aug 2021, at 16:15, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Daniel Gustafsson <daniel@yesql.se> writes:

On 27 Aug 2021, at 15:52, Dave Cramer <davecramer@gmail.com> wrote:

In my mind "in the event that it crashes" made it clear

That, or “if it crashes” gets my vote.

Dave's wording sounds good to me.

I can go make that happen, backpatched down to 9.6 AFAICT on a quick skim,
unless you’re already on it.

--
Daniel Gustafsson https://vmware.com/

#10Tom Lane
tgl@sss.pgh.pa.us
In reply to: Daniel Gustafsson (#9)
Re: Background worker docs,

Daniel Gustafsson <daniel@yesql.se> writes:

On 27 Aug 2021, at 16:15, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Dave's wording sounds good to me.

I can go make that happen, backpatched down to 9.6 AFAICT on a quick skim,
unless you’re already on it.

Feel free, I've got other stuff on my plate right now.

regards, tom lane

#11Daniel Gustafsson
daniel@yesql.se
In reply to: Tom Lane (#10)
Re: Background worker docs,

On 27 Aug 2021, at 16:31, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Daniel Gustafsson <daniel@yesql.se> writes:

On 27 Aug 2021, at 16:15, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Dave's wording sounds good to me.

I can go make that happen, backpatched down to 9.6 AFAICT on a quick skim,
unless you’re already on it.

Feel free, I've got other stuff on my plate right now.

And done, thanks.

--
Daniel Gustafsson https://vmware.com/