tiny documentation fix

Started by Amit Langotealmost 6 years ago6 messages
#1Amit Langote
amitlangote09@gmail.com
1 attachment(s)

Hi,

I propose this small fix for 27.4. Progress Reporting:

-    all of its partitions are also recursively analyzed as also mentioned on
+    all of its partitions are also recursively analyzed as also mentioned in
     <xref linkend="sql-analyze"/>.

Note the last word: "in" sounds more correct.

Thanks,
Amit

Attachments:

doc-monitoring-grammar.patchtext/plain; charset=US-ASCII; name=doc-monitoring-grammar.patchDownload
diff --git a/doc/src/sgml/monitoring.sgml b/doc/src/sgml/monitoring.sgml
index 9129f79bbf..30334a6d5f 100644
--- a/doc/src/sgml/monitoring.sgml
+++ b/doc/src/sgml/monitoring.sgml
@@ -3698,7 +3698,7 @@ SELECT pg_stat_get_backend_pid(s.backendid) AS pid,
   <note>
    <para>
     Note that when <command>ANALYZE</command> is run on a partitioned table,
-    all of its partitions are also recursively analyzed as also mentioned on
+    all of its partitions are also recursively analyzed as also mentioned in
     <xref linkend="sql-analyze"/>.  In that case, <command>ANALYZE</command>
     progress is reported first for the parent table, whereby its inheritance
     statistics are collected, followed by that for each partition.
#2Michael Paquier
michael@paquier.xyz
In reply to: Amit Langote (#1)
Re: tiny documentation fix

On Mon, Feb 17, 2020 at 03:55:46PM +0900, Amit Langote wrote:

I propose this small fix for 27.4. Progress Reporting:

-    all of its partitions are also recursively analyzed as also mentioned on
+    all of its partitions are also recursively analyzed as also mentioned in
<xref linkend="sql-analyze"/>.

Note the last word: "in" sounds more correct.

What you are suggesting sounds much better to me than the original.
Do others have comments or objections?
--
Michael

#3Julien Rouhaud
rjuju123@gmail.com
In reply to: Michael Paquier (#2)
Re: tiny documentation fix

On Mon, Feb 17, 2020 at 10:43 AM Michael Paquier <michael@paquier.xyz> wrote:

On Mon, Feb 17, 2020 at 03:55:46PM +0900, Amit Langote wrote:

I propose this small fix for 27.4. Progress Reporting:

-    all of its partitions are also recursively analyzed as also mentioned on
+    all of its partitions are also recursively analyzed as also mentioned in
<xref linkend="sql-analyze"/>.

Note the last word: "in" sounds more correct.

What you are suggesting sounds much better to me than the original.
Do others have comments or objections?

+1 with Amit's suggestion.

#4Daniel Gustafsson
daniel@yesql.se
In reply to: Michael Paquier (#2)
Re: tiny documentation fix

On 17 Feb 2020, at 10:42, Michael Paquier <michael@paquier.xyz> wrote:

On Mon, Feb 17, 2020 at 03:55:46PM +0900, Amit Langote wrote:

I propose this small fix for 27.4. Progress Reporting:

-    all of its partitions are also recursively analyzed as also mentioned on
+    all of its partitions are also recursively analyzed as also mentioned in
<xref linkend="sql-analyze"/>.

Note the last word: "in" sounds more correct.

What you are suggesting sounds much better to me than the original.
Do others have comments or objections?

In my understanding, the difference comes from how the link is interpreted, is
the mention "on a webpage" or "in a section". Personally I prefer 'in' as it
works for the PDF docs as well as the web docs. In doc/src/sgml/mvcc.sgml
there is similar instance where we've used "in <xref ..":

"As mentioned in <xref linkend="xact-serializable"/>, Serializable
transactions are just Repeatable Read transactions which add"

Changing as per the patch makes these consistent, so +1 on doing that.

cheers ./daniel

#5Michael Paquier
michael@paquier.xyz
In reply to: Daniel Gustafsson (#4)
Re: tiny documentation fix

On Mon, Feb 17, 2020 at 01:06:21PM +0100, Daniel Gustafsson wrote:

Changing as per the patch makes these consistent, so +1 on doing that.

Thanks, applied.
--
Michael

#6Amit Langote
amitlangote09@gmail.com
In reply to: Michael Paquier (#5)
Re: tiny documentation fix

On Tue, Feb 18, 2020 at 10:56 Michael Paquier <michael@paquier.xyz> wrote:

On Mon, Feb 17, 2020 at 01:06:21PM +0100, Daniel Gustafsson wrote:

Changing as per the patch makes these consistent, so +1 on doing that.

Thanks, applied.

Thank you.

- Amit

Show quoted text