Suggestion for the tables in documentation

From: fndevos(at)gmail(dot)com
To: pgsql-docs(at)postgresql(dot)org
Subject: Suggestion for the tables in documentation
Date: 2016-12-08 12:31:55
Message-ID: 20161208123155.1402.27288@wrigleys.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-docs

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/9.6/static/functions-string.html
Description:

Hello,

The documentation contains a lot of tables with long function names that do
not wrap. This leads to a lot of strings breaking out of table cells.

There are ways to reformat these tables, for example, by turning 3+ column
tables into a series of 2 column tables whereby the original columns are
turned into rows.

For example:

Function | Return Type | Description | Example | Result
(with rows of overlapping data below that in PDF and very wide screens with
horizontal scrollbars in HTML)

would become

Function | ...
Return Type | ...
Description | ...
Example | ...
Result | ...

(empty line followed by next row as a table)

This could surely be automated. The documentation would be so much easier to
use.

Just a suggestion.

Best regards,
Frederik De Vos

Browse pgsql-docs by date

  From Date Subject
Next Message vodevsh 2016-12-09 13:05:49 jsonb_each_text(jsonb) returns value::jsonb, not text
Previous Message 62mkv 2016-12-06 08:21:39 WANTED: more details on "pg_databases" and/or "deleting template1 database"