pg.ddx.io  pgsql-docs@postgresql.org mailing list archive  
help / color / mirror / Atom feed
From: fndevos@gmail.com
To: pgsql-docs@postgresql.org
Subject: Suggestion for the tables in documentation
Date: Thu, 08 Dec 2016 12:31:55 +0000
Message-ID: <20161208123155.1402.27288@wrigleys.postgresql.org> (raw)
List-Unsubscribe: <mailto:majordomo@postgresql.org?body=unsub%20pgsql-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


-- 
Sent via pgsql-docs mailing list (pgsql-docs@postgresql.org)
To make changes to your subscription:
http://www.postgresql.org/mailpref/pgsql-docs


Message-ID: <20161208123155.1402.27288@wrigleys.postgresql.org>
Permalink:  ../20161208123155.1402.27288@wrigleys.postgresql.org/
Also on:    postgresql.org/message-id/20161208123155.1402.27288@wrigleys.postgresql.org

 · 

reply

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Reply to all the recipients using the --to and --cc options:
  reply via email

  To: pgsql-docs@postgresql.org
  Cc: fndevos@gmail.com
  Subject: Re: Suggestion for the tables in documentation
  In-Reply-To: <20161208123155.1402.27288@wrigleys.postgresql.org>

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox