Обсуждение: Typos in the featurematrix
While working on something else I noticed that the featurematrix has a few typos, unless there are objections I'll go ahead with the attached. -- Daniel Gustafsson
Вложения
On Tue, 14 Oct 2025 at 20:46, Daniel Gustafsson <daniel@yesql.se> wrote:
> While working on something else I noticed that the featurematrix has a few
> typos, unless there are objections I'll go ahead with the attached.
Patch looks good.
I had a read and found a few more:
conjunction with a RETURNING clause to to pass data up to the
containing query.
too many to's.
description: Extend statistics can help the query planner provided
better plans
I think "Extended" and "provide" instead of 'provided' or better yet "generate"
for queries that have "OR".clauses as well as "IN/ANY" lookups
over lists. For
I think "OR" should be followed by a space instead of a fullstop/period.
JSON data strings can now to be converted into records and new
functions to
"to" seems misplaced.
description: "Write conflicts that occur during ogical replication are\
"logical"
available in order for a standbys of the new primary to
correctly switch to
"standbys" should be singular or the "a " should be removed.
description: Ability to require synch messages from multiple
prioritized standbys
I don't know that "synch" is necessarily incorrect, but I don't see it
being used in our codebase. We normally spell it "sync".
description: adds support for authentictaing against a RADIUS server
"authenticating"
description: replaces user and group concept by a more generalizes
role based
Maybe "replaces user and group concept with a more generalized role based"
description: simply way to return the result of an arbitrary query
in pl/pgsql
"simple"
David
> On 15 Oct 2025, at 13:00, David Rowley <dgrowleyml@gmail.com> wrote: > > On Tue, 14 Oct 2025 at 20:46, Daniel Gustafsson <daniel@yesql.se> wrote: >> While working on something else I noticed that the featurematrix has a few >> typos, unless there are objections I'll go ahead with the attached. > > Patch looks good. > > I had a read and found a few more: Thanks, I have incorporated all of these in the v2 attached. When doing that I noticed that the capitilization of PL/pgSQL and other PL's was quite varied. 0002 in the attached corrects that to ensure consistency across the items in the featurematrix with corresponding names in the docs. Since I don't have a local version of the site running I am adding Magnus to cc: hoping he can validate that the patched file works. -- Daniel Gustafsson
Вложения
> On 15 Oct 2025, at 15:22, Daniel Gustafsson <daniel@yesql.se> wrote: > >> On 15 Oct 2025, at 13:00, David Rowley <dgrowleyml@gmail.com> wrote: >> >> On Tue, 14 Oct 2025 at 20:46, Daniel Gustafsson <daniel@yesql.se> wrote: >>> While working on something else I noticed that the featurematrix has a few >>> typos, unless there are objections I'll go ahead with the attached. >> >> Patch looks good. >> >> I had a read and found a few more: > > Thanks, I have incorporated all of these in the v2 attached. > > When doing that I noticed that the capitilization of PL/pgSQL and other PL's > was quite varied. 0002 in the attached corrects that to ensure consistency > across the items in the featurematrix with corresponding names in the docs. The featurematrix was a rabbithole that went deep, looking closer I realized that links were using a variety of target versions: /current/, /devel/, or the version which was current at the time of adding. This means that for old features we we still linking to the 9.x version of the docs, which clearly isn't helpful to our users. We also had quite a few /static/ links which 301 redirects since we don't have that level anymore. On top of that, a few links in the descriptions were not markdown encoded and thus rendered as plain text. The attached v3 fixes these in 0003 and 0004. -- Daniel Gustafsson
Вложения
On Wed, 22 Oct 2025 at 01:09, Daniel Gustafsson <daniel@yesql.se> wrote: > The featurematrix was a rabbithole that went deep, looking closer I realized > that links were using a variety of target versions: /current/, /devel/, or the > version which was current at the time of adding. This means that for old > features we we still linking to the 9.x version of the docs, which clearly > isn't helpful to our users. We also had quite a few /static/ links which 301 > redirects since we don't have that level anymore. > > On top of that, a few links in the descriptions were not markdown encoded and > thus rendered as plain text. > > The attached v3 fixes these in 0003 and 0004. * The new link seems dead. Looks like it should be https://www.postgresql.org/docs/current/brin.html#BRIN-INTRO - url: https://www.postgresql.org/docs/current/static/brin-intro.html + url: https://www.postgresql.org/docs/current/brin-intro.html * Looks like this will cause issues as "current" moves forward in versions and we add new sections before this: - url: https://www.postgresql.org/docs/16/functions-aggregate.html#id-1.5.8.27.5.2.4.1.1.1.1 + url: https://www.postgresql.org/docs/current/functions-aggregate.html#id-1.5.8.27.6.2.4.1.1.1.1 If I adjust /current/ to /17/ it works, but not before then. Is there anything more future proof we can do there? Likewise with: - url: https://www.postgresql.org/docs/16/functions-info.html#id-1.5.8.32.3.4.2.2.24.1.1.1 + url: https://www.postgresql.org/docs/current/functions-info.html#id-1.5.8.33.3.4.2.2.26.1.1.1 Also: - url: https://www.postgresql.org/docs/18/functions-string.html#id-1.5.8.10.7.2.2.8.1.1.1 + url: https://www.postgresql.org/docs/current/functions-string.html#id-1.5.8.10.7.2.2.8.1.1.1 Going back to /14/ that links to left() instead of casefold(). * The following no longer links to where it intended to: - url: https://www.postgresql.org/docs/current/static/collation.html#id-1.6.10.4.5.7.5 + url: https://www.postgresql.org/docs/current/collation.html#id-1.6.10.4.5.7.5 i.e basically someone made the same mistake as the above ones were about to make. David
On Wed, 22 Oct 2025 at 12:56, David Rowley <dgrowleyml@gmail.com> wrote: > Also: > > - url: https://www.postgresql.org/docs/18/functions-string.html#id-1.5.8.10.7.2.2.8.1.1.1 > + url: https://www.postgresql.org/docs/current/functions-string.html#id-1.5.8.10.7.2.2.8.1.1.1 > > Going back to /14/ that links to left() instead of casefold(). Looking at: grep -F "<indexterm" doc/src/sgml/func/func-string.sgml I see there are only 3 functions where we've added a section, so [1] works, but not [2]. Maybe we should just add the remaining indexterms and backpatch to v18. Seems like there's none in: grep -F "<indexterm" doc/src/sgml/func/func-aggregate.sgml so all those would need added. I can't think of a reason not to do this. Maybe I've overlooked something? David [1] https://www.postgresql.org/docs/current/functions-string.html#FUNCTION-LOWER [2] https://www.postgresql.org/docs/current/functions-string.html#FUNCTION-UPPER
On 10/21/25 8:09 AM, Daniel Gustafsson wrote: >> On 15 Oct 2025, at 15:22, Daniel Gustafsson <daniel@yesql.se> wrote: >> >>> On 15 Oct 2025, at 13:00, David Rowley <dgrowleyml@gmail.com> wrote: >>> >>> On Tue, 14 Oct 2025 at 20:46, Daniel Gustafsson <daniel@yesql.se> wrote: >>>> While working on something else I noticed that the featurematrix has a few >>>> typos, unless there are objections I'll go ahead with the attached. >>> >>> Patch looks good. >>> >>> I had a read and found a few more: >> >> Thanks, I have incorporated all of these in the v2 attached. >> >> When doing that I noticed that the capitilization of PL/pgSQL and other PL's >> was quite varied. 0002 in the attached corrects that to ensure consistency >> across the items in the featurematrix with corresponding names in the docs. * Going through 0001: - description: automatic invalidation of cached exceutions plans + description: automatic invalidation of cached executions plans should probably be "cached execution plans". Otherwise LGTM. * Going through 0002: - - name: IN/OUT/INOUT parameters for pl/pgsql and PL/SQL + - name: IN/OUT/INOUT parameters for PL/pgSQL and PL/SQL We should probably not call it "PL/SQL" since it's not a procedural language. Perhaps: - - name: IN/OUT/INOUT parameters for pl/pgsql and PL/SQL + - name: IN/OUT/INOUT parameters for PL/pgSQL and SQL stored functions Otherwise LGTM. > The featurematrix was a rabbithole that went deep, looking closer I realized > that links were using a variety of target versions: /current/, /devel/, or the > version which was current at the time of adding. This means that for old > features we we still linking to the 9.x version of the docs, which clearly > isn't helpful to our users. We also had quite a few /static/ links which 301 > redirects since we don't have that level anymore. There were some reasons for this, the "version at the time of adding" ensuring that the links were accessible during the beta period (which also explained some of the /devel/, which I likely did). During the beta period, we'll still need to use the `/NN/` number so the links are accessible, but we can make it part of the procedure to more to `/current/` when we GA. Patch LGTM, assuming they're all tested ;) > On top of that, a few links in the descriptions were not markdown encoded and > thus rendered as plain text. > > The attached v3 fixes these in 0003 and 0004. 0004 LGTM. Thanks! Jonathan
Вложения
> On 23 Oct 2025, at 03:04, Jonathan S. Katz <jkatz@postgresql.org> wrote: > * Going through 0001: > > - description: automatic invalidation of cached exceutions plans > + description: automatic invalidation of cached executions plans > > should probably be "cached execution plans". Otherwise LGTM. Fixed > * Going through 0002: > > - - name: IN/OUT/INOUT parameters for pl/pgsql and PL/SQL > + - name: IN/OUT/INOUT parameters for PL/pgSQL and PL/SQL > > We should probably not call it "PL/SQL" since it's not a procedural language. Perhaps: > > - - name: IN/OUT/INOUT parameters for pl/pgsql and PL/SQL > + - name: IN/OUT/INOUT parameters for PL/pgSQL and SQL stored functions Fixed >> The featurematrix was a rabbithole that went deep, looking closer I realized >> that links were using a variety of target versions: /current/, /devel/, or the >> version which was current at the time of adding. This means that for old >> features we we still linking to the 9.x version of the docs, which clearly >> isn't helpful to our users. We also had quite a few /static/ links which 301 >> redirects since we don't have that level anymore. > > There were some reasons for this, the "version at the time of adding" ensuring that the links were accessible during thebeta period (which also explained some of the /devel/, which I likely did). During the beta period, we'll still need touse the `/NN/` number so the links are accessible, but we can make it part of the procedure to more to `/current/` whenwe GA. That makes a lot of sense. We also need to use the /NN/ number for any feature which is removed, to stabilise the link on the last version where it was present. Adding a "link-refresh" step to the GA checklist sounds like a good idea (and I can volunteer to tackle it next time). -- Daniel Gustafsson
> On 22 Oct 2025, at 01:56, David Rowley <dgrowleyml@gmail.com> wrote: > > On Wed, 22 Oct 2025 at 01:09, Daniel Gustafsson <daniel@yesql.se> wrote: >> The featurematrix was a rabbithole that went deep, looking closer I realized >> that links were using a variety of target versions: /current/, /devel/, or the >> version which was current at the time of adding. This means that for old >> features we we still linking to the 9.x version of the docs, which clearly >> isn't helpful to our users. We also had quite a few /static/ links which 301 >> redirects since we don't have that level anymore. >> >> On top of that, a few links in the descriptions were not markdown encoded and >> thus rendered as plain text. >> >> The attached v3 fixes these in 0003 and 0004. > > * The new link seems dead. Looks like it should be > https://www.postgresql.org/docs/current/brin.html#BRIN-INTRO Indeed, fixed. > * Looks like this will cause issues as "current" moves forward in > versions and we add new sections before this: > > - url: https://www.postgresql.org/docs/16/functions-aggregate.html#id-1.5.8.27.5.2.4.1.1.1.1 > + url: https://www.postgresql.org/docs/current/functions-aggregate.html#id-1.5.8.27.6.2.4.1.1.1.1 > > If I adjust /current/ to /17/ it works, but not before then. Is there > anything more future proof we can do there? Adding anchors with indexterms, as you mention downthread, to anything in the featurematrix is the solution to providing stable links. A manual step of verifying links at time of GA is another option, which is probably a good idea regardless. > Going back to /14/ that links to left() instead of casefold(). Right, but that's only if you edit the url and I don't think we can ever protect ourselves from users manually testing links. If you go to the above page and click on the link for v14 documentation it won't use the anchor and thus works. > * The following no longer links to where it intended to: > > - url: https://www.postgresql.org/docs/current/static/collation.html#id-1.6.10.4.5.7.5 > + url: https://www.postgresql.org/docs/current/collation.html#id-1.6.10.4.5.7.5 > > i.e basically someone made the same mistake as the above ones were > about to make. Interesting, the history of that edit is lost as it was done when the matrix was defined in the database and not in a standalone yaml file. The correct link seems to be: https://www.postgresql.org/docs/current/collation.html#ICU-CUSTOM-COLLATIONS -- Daniel Gustafsson
> On 22 Oct 2025, at 02:36, David Rowley <dgrowleyml@gmail.com> wrote: > > On Wed, 22 Oct 2025 at 12:56, David Rowley <dgrowleyml@gmail.com> wrote: >> Also: >> >> - url: https://www.postgresql.org/docs/18/functions-string.html#id-1.5.8.10.7.2.2.8.1.1.1 >> + url: https://www.postgresql.org/docs/current/functions-string.html#id-1.5.8.10.7.2.2.8.1.1.1 >> >> Going back to /14/ that links to left() instead of casefold(). > > Looking at: > > grep -F "<indexterm" doc/src/sgml/func/func-string.sgml > > I see there are only 3 functions where we've added a section, so [1] > works, but not [2]. Maybe we should just add the remaining indexterms > and backpatch to v18. > > Seems like there's none in: > > grep -F "<indexterm" doc/src/sgml/func/func-aggregate.sgml > > so all those would need added. > > I can't think of a reason not to do this. Maybe I've overlooked something? I can't think of any, I'll go do that (and propose it on -docs) before making the featurematrix commit. -- Daniel Gustafsson