collation settings table in v16 docs

From: Jeremy Schneider <schneider(at)ardentperf(dot)com>
To: "Davis, Jeff" <jefdavj(at)amazon(dot)com>, Peter Eisentraut <peter(dot)eisentraut(at)enterprisedb(dot)com>, "Jonathan S(dot) Katz" <jkatz(at)postgresql(dot)org>, Robert Haas <robertmhaas(at)gmail(dot)com>
Cc: PostgreSQL-development <pgsql-hackers(at)postgresql(dot)org>
Subject: collation settings table in v16 docs
Date: 2023-06-05 02:31:33
Message-ID: 2e2dc1ce-5fa0-3101-d57d-73975012bd98@ardentperf.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

Looking at the "collation settings" table in the v16 docs, I think some
readers may have a little difficulty understanding what each row means.

https://www.postgresql.org/docs/devel/collation.html#ICU-COLLATION-SETTINGS

The "Key" column isn't meaningful and it's a bit arduous to read the
whole description column for every row in the table, just to understand
which keys I might be interested in.

I like how Peter's recent blog used the alias to organize the keys.

http://peter.eisentraut.org/blog/2023/05/16/overview-of-icu-collation-settings

I'd suggest that we add a column to this table with the alias, and also
have a consistent first sentence of each description, generally aligned
with the description from the upstream XML that Peter also referenced in
his blog.

I have an example below (and patch attached); I think this would make
the table a bit more understandable.

-Jeremy

===

Key: ka
Alias: colAlternate **<-added**
Values: noignore, shifted
Default: noignore
Description: **Collation parameter key for alternate handling.** If set
to shifted, causes some characters (e.g. punctuation or space) to be
ignored in comparison. Key ks must be set to level3 or lower to take
effect. Set key kv to control which character classes are ignored.

===

Key: kb
Alias: colBackwards **<-added**
Values: true, false
Default: false
Description: **Collation parameter key for backwards comparison of** the
level 2 differences. For example, locale und-u-kb sorts 'àe' before 'aé'.

--
http://about.me/jeremy_schneider

Attachment Content-Type Size
01-doc-update-proposal.patch text/plain 7.1 KB

Browse pgsql-hackers by date

  From Date Subject
Next Message Richard Guo 2023-06-05 02:37:10 Re: Avoid unncessary always true test (src/backend/storage/buffer/bufmgr.c)
Previous Message Bharath Rupireddy 2023-06-05 02:30:00 Re: New Table Access Methods for Multi and Single Inserts