[PGDOCS] change function linkend to refer to a more relevant target

Started by Peter Smithover 2 years ago4 messages
#1Peter Smith
smithpb2250@gmail.com
1 attachment(s)

Hi,

I found a link in the docs that referred to the stats "views" section,
instead of the more relevant (IMO) stats "functions" section.

PSA the 1 line patch -- it explains what I mean better than I can
describe in words...

======
Kind Regards,
Peter Smith.
Fujitsu Australia

Attachments:

v1-0001-Change-the-xref-linkend.patchapplication/octet-stream; name=v1-0001-Change-the-xref-linkend.patchDownload
From e555f77d27915523bb02fc9d872821267dad3984 Mon Sep 17 00:00:00 2001
From: Peter Smith <peter.b.smith@fujitsu.com>
Date: Fri, 29 Sep 2023 14:32:40 +1000
Subject: [PATCH v1] Change the xref linkend

---
 doc/src/sgml/func.sgml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 24ad87f..f1ad64c 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -22851,7 +22851,7 @@ SELECT * FROM pg_ls_dir('.') WITH ORDINALITY AS t(ls,n);
   <para>
    In addition to the functions listed in this section, there are a number of
    functions related to the statistics system that also provide system
-   information. See <xref linkend="monitoring-stats-views"/> for more
+   information. See <xref linkend="monitoring-stats-functions"/> for more
    information.
   </para>
 
-- 
1.8.3.1

#2Daniel Gustafsson
daniel@yesql.se
In reply to: Peter Smith (#1)
Re: [PGDOCS] change function linkend to refer to a more relevant target

On 29 Sep 2023, at 06:51, Peter Smith <smithpb2250@gmail.com> wrote:

I found a link in the docs that referred to the stats "views" section,
instead of the more relevant (IMO) stats "functions" section.

Agreed. This link was added in 2007 (in 7d3b7011b), and back in 7.3/7.4 days
the functions were listed in the same section as the views, so the anchor was
at the time pointing to the right section. In 2012 it was given its own
section (in aebe989477) but the link wasn't updated.

Thanks for the patch, I'll go ahead with it.

--
Daniel Gustafsson

#3Daniel Gustafsson
daniel@yesql.se
In reply to: Daniel Gustafsson (#2)
Re: [PGDOCS] change function linkend to refer to a more relevant target

On 29 Sep 2023, at 10:54, Daniel Gustafsson <daniel@yesql.se> wrote:

On 29 Sep 2023, at 06:51, Peter Smith <smithpb2250@gmail.com> wrote:

I found a link in the docs that referred to the stats "views" section,
instead of the more relevant (IMO) stats "functions" section.

Agreed. This link was added in 2007 (in 7d3b7011b), and back in 7.3/7.4 days
the functions were listed in the same section as the views, so the anchor was
at the time pointing to the right section. In 2012 it was given its own
section (in aebe989477) but the link wasn't updated.

Thanks for the patch, I'll go ahead with it.

Applied to all supported branches, thanks!

--
Daniel Gustafsson

#4Peter Smith
smithpb2250@gmail.com
In reply to: Daniel Gustafsson (#3)
Re: [PGDOCS] change function linkend to refer to a more relevant target

On Sat, Sep 30, 2023 at 12:04 AM Daniel Gustafsson <daniel@yesql.se> wrote:

On 29 Sep 2023, at 10:54, Daniel Gustafsson <daniel@yesql.se> wrote:

On 29 Sep 2023, at 06:51, Peter Smith <smithpb2250@gmail.com> wrote:

I found a link in the docs that referred to the stats "views" section,
instead of the more relevant (IMO) stats "functions" section.

Agreed. This link was added in 2007 (in 7d3b7011b), and back in 7.3/7.4 days
the functions were listed in the same section as the views, so the anchor was
at the time pointing to the right section. In 2012 it was given its own
section (in aebe989477) but the link wasn't updated.

Thanks for the patch, I'll go ahead with it.

Applied to all supported branches, thanks!

Thank you for pushing.

======
Kind Regards,
Peter Smith.
Fujitsu Australia