Re: Another modest proposal for docs formatting: catalog descriptions
Tom Lane <tgl@sss.pgh.pa.us>
From: Tom Lane <tgl@sss.pgh.pa.us>
To: Fabien COELHO <coelho@cri.ensmp.fr>
Cc: pgsql-docs@lists.postgresql.org,
PostgreSQL Developers <pgsql-hackers@lists.postgresql.org>
Date: 2020-05-05T23:42:52Z
Lists: pgsql-hackers, pgsql-docs
Attachments
- pg_aggregate-description.patch (text/x-diff) patch
- pg_aggregate.png (image/png)
Here's a really quick-n-dirty prototype patch that just converts the pg_aggregate table to the proposed style, plus a screenshot for those who don't feel like actually building the docs with the patch. Looking at the results, it seems like we could really use a bit more horizontal space between the column names and data types, and perhaps also between the types and the (references) annotations. Other than that it looks decent. I don't know what's the cleanest way to add some space there --- I'd rather not have the SGML text do it explicitly. There's room for complaint that this takes up more vertical space than the old way, assuming you have a reasonably wide window. I'm not terribly bothered by that, but maybe someone else will be? I'm inclined to think that that's well worth the benefit that we won't feel compelled to keep column descriptions short. BTW, this being just a test hack, I repurposed the "func_table_entry" and "func_signature" style marker roles. If we do this for real then of course we'd want to use different roles, even if they happen to mark up the same for now. regards, tom lane
Commits
-
Doc: reformat catalog/view description tables.
- a042750646db 13.0 landed