Incorrect link tohttps://www.postgresql.org/docs/current/indexes-functional.html ?

Started by PG Bug reporting formalmost 3 years ago5 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/15/indexes-expressional.html
Description:

Hi, nice to meet you.

I found incorrect link to
https://www.postgresql.org/docs/current/indexes-functional.html on this page
https://www.postgresql.org/docs/7.3/indexes-functional.html. The text is
"...the same page for the current version...".

Is "functional index" in version 7.3 (or earlier) equivalent to the
"Indexes on Expressions" in the current version?
If so, is correct URL
https://www.postgresql.org/docs/current/indexes-expressional.html ?

Would you check and correct it?

Thank you in advance.

#2Tom Lane
tgl@sss.pgh.pa.us
In reply to: PG Bug reporting form (#1)
Re: Incorrect link tohttps://www.postgresql.org/docs/current/indexes-functional.html ?

PG Doc comments form <noreply@postgresql.org> writes:

I found incorrect link to
https://www.postgresql.org/docs/current/indexes-functional.html on this page
https://www.postgresql.org/docs/7.3/indexes-functional.html.

PG 7.3 has been out of support for more than fifteen years. Nobody
is going to correct any errors that may exist in those doc pages.
They're just there for historical reference.

regards, tom lane

#3Daniel Gustafsson
daniel@yesql.se
In reply to: Tom Lane (#2)
Re: Incorrect link tohttps://www.postgresql.org/docs/current/indexes-functional.html ?

On 5 May 2023, at 13:03, Tom Lane <tgl@sss.pgh.pa.us> wrote:

PG Doc comments form <noreply@postgresql.org> writes:

I found incorrect link to
https://www.postgresql.org/docs/current/indexes-functional.html on this page
https://www.postgresql.org/docs/7.3/indexes-functional.html.

PG 7.3 has been out of support for more than fifteen years. Nobody
is going to correct any errors that may exist in those doc pages.
They're just there for historical reference.

This is actually not an error in the 7.3 docs (which we clearly wouldn't
address) but an error in pgweb in the warning for unsupported versions; it
assumes it can link to the same page in /current. The relevant code is:

This documentation is for an unsupported version of PostgreSQL.<br/>
You may want to view the same page for the
<a href="/docs/current/{{page.file}}" title="PostgreSQL {{page.version.display_version}} - {{page.title}}">current</a>

This may well hit us in just-out-of-support versions which are still in use,
but until there is a report from a more recent version than 7.3 there isn't
much cause for concern I reckon.

--
Daniel Gustafsson

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Daniel Gustafsson (#3)
Re: Incorrect link tohttps://www.postgresql.org/docs/current/indexes-functional.html ?

Daniel Gustafsson <daniel@yesql.se> writes:

This is actually not an error in the 7.3 docs (which we clearly wouldn't
address) but an error in pgweb in the warning for unsupported versions; it
assumes it can link to the same page in /current.

Ah, good point. And it does know that the page doesn't exist in /current,
because the "same page in other versions" list just above doesn't include
that. Maybe we could have the link to "current" point to the docs top
level instead of the specific page in such cases? Or simpler, just omit
the "You may want to view the same page..." sentence altogether.

regards, tom lane

#5Daniel Gustafsson
daniel@yesql.se
In reply to: Tom Lane (#4)
Re: Incorrect link tohttps://www.postgresql.org/docs/current/indexes-functional.html ?

On 5 May 2023, at 15:42, Tom Lane <tgl@sss.pgh.pa.us> wrote:

Daniel Gustafsson <daniel@yesql.se> writes:

This is actually not an error in the 7.3 docs (which we clearly wouldn't
address) but an error in pgweb in the warning for unsupported versions; it
assumes it can link to the same page in /current.

Ah, good point. And it does know that the page doesn't exist in /current,
because the "same page in other versions" list just above doesn't include
that. Maybe we could have the link to "current" point to the docs top
level instead of the specific page in such cases? Or simpler, just omit
the "You may want to view the same page..." sentence altogether.

Since this particular page doesn't exist in any supported version, the text in
the box is actually wrong twice:

"You may want to view the same page for the current version, or one of the
other supported versions listed above instead."

Since we know when rendering the page which versions it does exist in we could
set one of three template variables:

exist_in_current
exist_in_supported
exist_in_unsupported

Depending on which is set we can choose the right text for the box. That being
said, we should probably move this to -www for exposure among those who
actually know the pgweb backend.

--
Daniel Gustafsson