RE: [PGdocs] fix description for handling pf non-ASCII characters
Hayato Kuroda (Fujitsu) <kuroda.hayato@fujitsu.com>
From: "Hayato Kuroda (Fujitsu)" <kuroda.hayato@fujitsu.com>
To: "'Karl O. Pinc'" <kop@karlpinc.com>
Cc: 'jian he' <jian.universality@gmail.com>, Postgres hackers <pgsql-hackers@lists.postgresql.org>
Date: 2023-09-27T12:58:54Z
Lists: pgsql-hackers
Attachments
- Both_v3-0001-Fix-description-for-handling-of-non-printable-AS.txt (text/plain)
- v3-0001-Fix-description-for-handling-of-non-printable-AS.patch (application/octet-stream) patch v3-0001
- Peter_v3-0001-Fix-description-for-handling-of-non-printable-AS.txt (text/plain)
Dear Karl, Thank you for reviewing! > A related thing that's nice to have is to limit the line > length of the documentation source to 80 characters or less. > 79 is probably best. Since the source text around your patch > conforms to this convention you should also. IIUC it is not hard limit, but I followed this. > Should the committer be interested, your patch applies cleanly > and the docs build as expected. Yeah, but cfbot accepted previous version. Did you have anything in your mind? > Also, based on the comments in the > patch which changed the system's behavior, I believe that > your patch updates all the relevant places in the documentation. Thanks. Actually, I think it should be backpatched to PG16 because the commit was done last year. I will make the patch for it after deciding the explanation. > > I now think that you should consider another change to your wording. > Instead of starting with "Characters that are not printable ASCII ..." > consider writing "The bytes of the string which are not printable ASCII > ...". Notice above that characters (e.g. あ) generate output for > each non-ASCII byte (e.g. \xe3\x81\x82). So my thought is that > the docs should be talking about bytes. > > For the last hunk you'd change around "anything". Write: > "... it will be truncated to less than NAMEDATALEN characters and > the bytes of the string which are not printable ASCII characters ...". > Hmm, what you said looked right. But as Peter pointed out [1], the fix seems too much. So I attached three version of patches. How do you think? For me, type C is best. A. A patch which completely follows your comments. The name is "v3-0001-...patch". Cfbot tests it. B. A patch which completely follows Peter's comments [1]. The name is "Peter_v3-....txt". C. A patch which follows both comments. Based on b, but some comments (Don't use the future tense, "Other characters"->"The bytes of other characters"...) were picked. The name is "Both_v3-....txt". [1]: https://www.postgresql.org/message-id/CAHut%2BPvEbKC8ABA_daX-XPNOTFzuAmHGhjPj%3DtPZYQskRHECOg%40mail.gmail.com Best Regards, Hayato Kuroda FUJITSU LIMITED
Commits
Same data as JSON:
GET /api/v1/messages/:b64id/commits
the thread's linked commits as JSON, with link sources.
API reference →
-
doc: Fix descriptions related to the handling of non-ASCII characters
- 950e236e5069 16.1 landed
- 3ef18a90bdea 17.0 landed
-
pg_clean_ascii(): escape bytes rather than lose them
- 45b1a67a0fcb 16.0 cited
-
Make locale option behavior more consistent
- da5d4ea5aaac 16.0 cited