Re: Lack of detailed documentation - Mailing list pgsql-docs

From Tom Lane
Subject Re: Lack of detailed documentation
Date
Msg-id 27125.1581367420@sss.pgh.pa.us
Whole thread Raw
In response to Re: Lack of detailed documentation  ("David G. Johnston" <david.g.johnston@gmail.com>)
Responses Re: Lack of detailed documentation  (Tom Lane <tgl@sss.pgh.pa.us>)
List pgsql-docs
"David G. Johnston" <david.g.johnston@gmail.com> writes:
> I doubt anyone disagrees with the sentiment but the last time the lack of
> documentation was brought up here was years ago and no one stepped up then
> to volunteer their time to improve this lesser used area of the database
> and it doesn't seem likely to happen organically here either as this
> message seems to imply a lack of interest in being part of the solution.

Yeah.  Attached is my proposal for clarifying what to do to rotate.
There's a lot more that could be done to improve this page --- for
one thing, most of the other similar tables show the results of the
examples, and for another, it's pretty unclear which data types
each operator takes.  But I don't have the time or interest to
tackle a major rewrite, and so far nobody else has stepped up either.

One thing that's sort of blocking any real progress on this is the
draconian space constraints imposed by the tabular format, which is
hurting us on a lot of these pages, not just this one.  Alvaro did
some preliminary investigation towards finding a better way [1],
but nobody's tried to push that forward.

            regards, tom lane

[1] https://www.postgresql.org/message-id/20200116184444.GA25792%40alvherre.pgsql

diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index ceda48e..400b21d 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -8363,12 +8363,18 @@ CREATE TYPE rainbow AS ENUM ('red', 'orange', 'yellow', 'green', 'blue', 'purple
        <row>
         <entry> <literal>*</literal> </entry>
         <entry>Scaling/rotation</entry>
-        <entry><literal>box '((0,0),(1,1))' * point '(2.0,0)'</literal></entry>
+        <entry>
+         <para><literal>path '(0,0),(1,0),(1,1)' * point '(3.0,0)'</literal></para>
+         <para><literal>path '(0,0),(1,0),(1,1)' * point(cosd(45), sind(45))</literal></para>
+        </entry>
        </row>
        <row>
         <entry> <literal>/</literal> </entry>
         <entry>Scaling/rotation</entry>
-        <entry><literal>box '((0,0),(2,2))' / point '(2.0,0)'</literal></entry>
+        <entry>
+         <para><literal>path '(0,0),(1,0),(1,1)' / point '(2.0,0)'</literal></para>
+         <para><literal>path '(0,0),(1,0),(1,1)' / point(cosd(45), sind(45))</literal></para>
+        </entry>
        </row>
        <row>
         <entry> <literal>#</literal> </entry>

pgsql-docs by date:

Previous
From: "David G. Johnston"
Date:
Subject: Re: Lack of detailed documentation
Next
From: Tom Lane
Date:
Subject: Duplicating website's formatting in local doc builds