Re: [very minor] Documentation suggestion

[Bruce Momjian]

On Fri, Oct 21, 2022 at 02:19:12AM +, PG Doc comments form wrote:
> The following documentation comment has been logged on the website:
> 
> Page: https://www.postgresql.org/docs/15/logicaldecoding-synchronous.html
> Description:
> 
> Very minor suggestion. Earlier on this page, commands are referred to that
> can cause "a deadlock". Later on the page, it says "cause deadlock".
> 
> https://www.postgresql.org/account/comments/new/15/logicaldecoding-synchronous.html/
> 
> "Note that these commands that can cause deadlock"

The full sentence is:

 Note that these commands that can cause deadlock apply to not only
 explicitly indicated system catalog tables above but also to any other
 [user] catalog table.

What I think it means is:

 Note that these commands, that can cause deadlock, apply to not only
 explicitly indicated system catalog tables above but also to any other
 [user] catalog table.

so with "a" it would be:

 Note that these commands, that can cause a deadlock, apply to not only
 explicitly indicated system catalog tables above but also to any other
 [user] catalog table.

but it still needs help ;-)  Here is the text I just applied:

 Note that these commands can cause deadlocks not only for the system
 catalog tables listed above but for other catalog tables.

Attached is the applied patch to master.

-- 
  Bruce Momjian  https://momjian.us
  EDB  https://enterprisedb.com

  Only you can decide what is important to you.
commit 16ace6f745
Author: Bruce Momjian 
Date:   Fri Oct 27 11:35:47 2023 -0400

doc: clarify logical decoding's deadlock of system tables

Reported-by: andyatkin...@gmail.com

Discussion: https://postgr.es/m/166631875298.630.2861049399528658...@wrigleys.postgresql.org

Backpatch-through: master

diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
index 5af016cfa9..8067946a25 100644
--- a/doc/src/sgml/logicaldecoding.sgml
+++ b/doc/src/sgml/logicaldecoding.sgml
@@ -1197,9 +1197,8 @@ OutputPluginWrite(ctx, true);
   
  
 
- Note that these commands that can cause deadlock apply to not only explicitly
- indicated system catalog tables above but also to any other [user] catalog
- table.
+ Note that these commands can cause deadlocks not only for the system
+ catalog tables listed above but for other catalog tables.
 

   

[very minor] Documentation suggestion

[PG Doc comments form]

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/15/logicaldecoding-synchronous.html
Description:

Very minor suggestion. Earlier on this page, commands are referred to that
can cause "a deadlock". Later on the page, it says "cause deadlock".

https://www.postgresql.org/account/comments/new/15/logicaldecoding-synchronous.html/

"Note that these commands that can cause deadlock"

I think that may also be grammatically correct, however I thought "a
deadlock" (adding the "a") sounded smoother to me when reading. Suggestion
below (adds "a" before "deadlock").

"Note that these commands that can cause a deadlock"