Re: [PATCH] document
Fujii Masao <masao.fujii@oss.nttdata.com>
From: Fujii Masao <masao.fujii@oss.nttdata.com>
To: Laurenz Albe <laurenz.albe@cybertec.at>,
Ian Lawrence Barwick <barwick@gmail.com>,
pgsql-hackers <pgsql-hackers@postgresql.org>
Date: 2021-08-25T13:21:36Z
Lists: pgsql-hackers
On 2021/07/14 14:45, Laurenz Albe wrote: > On Wed, 2021-07-14 at 14:43 +0900, Ian Lawrence Barwick wrote: >> Hi >> >> The description for "pg_database" [1] mentions the function >> "pg_encoding_to_char()", but this is not described anywhere in the docs. Given >> that that it (and the corresponding "pg_char_to_encoding()") have been around >> since 7.0 [2], it's probably not a burning issue, but it seems not entirely >> unreasonable to add short descriptions for both (and link from "pg_conversion" >> while we're at it); see attached patch. "System Catalog Information Functions" >> seems the most logical place to put these. >> >> [1] https://www.postgresql.org/docs/current/catalog-pg-database.html >> [2] https://git.postgresql.org/gitweb/?p=postgresql.git;a=commit;h=5eb1d0deb15f2b7cd0051bef12f3e091516c723b >> >> Will add to the next commitfest. > > +1 +1 When I applied the patch to the master, I found that the table entries for those function were added into the table for aclitem functions in the docs. I think this is not valid position and needs to be moved to the proper one (maybe the table for system catalog information functions?). + <returnvalue>int</returnvalue> + <function>pg_encoding_to_char</function> ( <parameter>encoding</parameter> <type>int</type> ) It's better to s/int/integer because the entries for other functions in func.sgml use "integer". Regards, -- Fujii Masao Advanced Computing Technology Center Research and Development Headquarters NTT DATA CORPORATION
Commits
-
doc: Document pg_encoding_to_char() and pg_char_to_encoding().
- f6b5d05ba9a4 15.0 landed
-
Add builtin functions:
- 5eb1d0deb15f 7.1.1 cited