Unhelpful typesetting of callouts in example queries in the docs

Started by Thomas Munroabout 9 years ago2 messageshackers
Jump to latest
#1Thomas Munro
thomas.munro@gmail.com

Hi

A novice user asked me about the last example here, which kept producing errors:

https://www.postgresql.org/docs/9.6/static/tutorial-agg.html?

It turned out that the 'callout' was causing confusion because it
sticks "(1)" into the middle of the query in approximately the same
typeface:

SELECT city, max(temp_lo)
FROM weather
WHERE city LIKE 'S%'(1)
GROUP BY city
HAVING max(temp_lo) < 40;

Maybe we should move it over a bit (?) and make it a comment, in case
it gets copied-and-pasted or otherwise misinterpreted?

SELECT city, max(temp_lo)
FROM weather
WHERE city LIKE 'S%' -- (1)
GROUP BY city
HAVING max(temp_lo) < 40;

See attached which does that and there and a couple of other places.

--
Thomas Munro
http://www.enterprisedb.com

Attachments:

put-callouts-in-sql-comments.patchapplication/octet-stream; name=put-callouts-in-sql-comments.patchDownload+6-6
#2Peter Eisentraut
peter_e@gmx.net
In reply to: Thomas Munro (#1)
Re: Unhelpful typesetting of callouts in example queries in the docs

On 2/27/17 21:49, Thomas Munro wrote:

It turned out that the 'callout' was causing confusion because it
sticks "(1)" into the middle of the query in approximately the same
typeface:

Maybe we should move it over a bit (?) and make it a comment, in case
it gets copied-and-pasted or otherwise misinterpreted?

committed

--
Peter Eisentraut http://www.2ndQuadrant.com/
PostgreSQL Development, 24x7 Support, Remote DBA, Training & Services

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