pg.ddx.io pgsql-docs@postgresql.org mailing list archive
help / color / mirror / Atom feedChapter 7. Queries
4+ messages / 2 participants
[nested] [flat]
Commits from this thread:
2020-11-02 8ef2a5afdf doc: Mention UNION/ORDER BY etc. keywords in section headers.
* Chapter 7. Queries
@ 2020-09-11 08:45 PG Doc comments form <noreply@postgresql.org>
2020-09-15 01:03 ` Re: Chapter 7. Queries David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: PG Doc comments form @ 2020-09-11 08:45 UTC (permalink / raw)
To: pgsql-docs@lists.postgresql.org; +Cc: bilge@scriptfusion.com
The following documentation comment has been logged on the website:
Page: https://www.postgresql.org/docs/12/queries.html
Description:
I like to browse documentation by index rather than searching. The Postgres
documentation is fairly well organized so this is easy for most topics.
However, on the "Chapter 7. Queries" index page, I often think I am in the
wrong place if I am looking for information about UNION or ORDER BY, because
those keywords are missing from that page. Unlike all the other headings,
the headings for these two topics does not include the relevant keywords in
teletype. I think it is important to include the keywords, particularly for
people whom already know which keyword they're looking for.
For example, I propose the following changes:
7.4. Combining Queries -> 7.4. Combining Queries with UNION
7.5. Sorting Rows -> 7.5. Sorting Rows with ORDER BY
If there are other examples I've missed where a topic is bound to a specific
keyword, they should updated similarly.
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Chapter 7. Queries
2020-09-11 08:45 Chapter 7. Queries PG Doc comments form <noreply@postgresql.org>
@ 2020-09-15 01:03 ` David G. Johnston <david.g.johnston@gmail.com>
2020-10-02 21:00 ` Re: Chapter 7. Queries David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: David G. Johnston @ 2020-09-15 01:03 UTC (permalink / raw)
To: bilge@scriptfusion.com, Pg Docs <pgsql-docs@lists.postgresql.org>
On Fri, Sep 11, 2020 at 2:37 AM PG Doc comments form <noreply@postgresql.org>
wrote:
> The following documentation comment has been logged on the website:
>
> Page: https://www.postgresql.org/docs/12/queries.html
> Description:
>
> I like to browse documentation by index rather than searching.
What you describe is browsing the table of contents.
> The Postgres
> documentation is fairly well organized so this is easy for most topics.
> However, on the "Chapter 7. Queries" index page, I often think I am in the
> wrong place if I am looking for information about UNION or ORDER BY,
> because
> those keywords are missing from that page. Unlike all the other headings,
> the headings for these two topics does not include the relevant keywords in
> teletype. I think it is important to include the keywords, particularly for
> people whom already know which keyword they're looking for.
>
The "index" is an actual section and searching for both UNION and ORDER BY
turns up entries there.
For example, I propose the following changes:
> 7.4. Combining Queries -> 7.4. Combining Queries with UNION
> 7.5. Sorting Rows -> 7.5. Sorting Rows with ORDER BY
>
Given that 7.6 is named "LIMIT and OFFSET" I don't have an issue with
adding the relevant keywords (including EXCEPT and INTERSECT) in those two
places.
If there are other examples I've missed where a topic is bound to a specific
> keyword, they should updated similarly.
>
I didn't look for any...
David J.
^ permalink raw reply [nested|flat] 4+ messages in thread
* Re: Chapter 7. Queries
2020-09-11 08:45 Chapter 7. Queries PG Doc comments form <noreply@postgresql.org>
2020-09-15 01:03 ` Re: Chapter 7. Queries David G. Johnston <david.g.johnston@gmail.com>
@ 2020-10-02 21:00 ` David G. Johnston <david.g.johnston@gmail.com>
2020-10-21 15:02 ` Re: Chapter 7. Queries David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 1 reply; 4+ messages in thread
From: David G. Johnston @ 2020-10-02 21:00 UTC (permalink / raw)
To: bilge@scriptfusion.com, Pg Docs <pgsql-docs@lists.postgresql.org>
On Mon, Sep 14, 2020 at 6:03 PM David G. Johnston <
david.g.johnston@gmail.com> wrote:
> Given that 7.6 is named "LIMIT and OFFSET" I don't have an issue with
> adding the relevant keywords (including EXCEPT and INTERSECT) in those two
> places.
>
Patch attached.
David J.
Attachments:
v1-doc-add-select-literals-to-queries-section-headers.patch (application/octet-stream, 1.2K) download
commit d871322ac9172dd430e664df9bf418d7f260b34e
Author: David G. Johnston <david.g.johnston@gmail.com>
Date: Fri Oct 2 20:58:17 2020 +0000
doc: Add select clause literals to queries chapter section headers
Most of the section and sub-section headers in the queries chapter
have the select commands clauses literally stated, but neither
sorting nor combining did. Add them.
diff --git a/doc/src/sgml/queries.sgml b/doc/src/sgml/queries.sgml
index 0a643ef597..76f33aa83d 100644
--- a/doc/src/sgml/queries.sgml
+++ b/doc/src/sgml/queries.sgml
@@ -1593,7 +1593,7 @@ SELECT DISTINCT ON (<replaceable>expression</replaceable> <optional>, <replaceab
<sect1 id="queries-union">
- <title>Combining Queries</title>
+ <title>Combining Queries (<literal>UNION</literal>, <literal>INTERSECT</literal>, <literal>EXCEPT</literal>)</title>
<indexterm zone="queries-union">
<primary>UNION</primary>
@@ -1673,7 +1673,7 @@ SELECT DISTINCT ON (<replaceable>expression</replaceable> <optional>, <replaceab
<sect1 id="queries-order">
- <title>Sorting Rows</title>
+ <title>Sorting Rows (<literal>ORDER BY</literal>)</title>
<indexterm zone="queries-order">
<primary>sorting</primary>
* Re: Chapter 7. Queries
2020-09-11 08:45 Chapter 7. Queries PG Doc comments form <noreply@postgresql.org>
2020-09-15 01:03 ` Re: Chapter 7. Queries David G. Johnston <david.g.johnston@gmail.com>
2020-10-02 21:00 ` Re: Chapter 7. Queries David G. Johnston <david.g.johnston@gmail.com>
@ 2020-10-21 15:02 ` David G. Johnston <david.g.johnston@gmail.com>
0 siblings, 0 replies; 4+ messages in thread
From: David G. Johnston @ 2020-10-21 15:02 UTC (permalink / raw)
To: bilge@scriptfusion.com, Pg Docs <pgsql-docs@lists.postgresql.org>
Moved to -hackers and commitfest
https://www.postgresql.org/message-id/CAKFQuwbqkcLCJ3gXUjso74gy80yNkB%3DFQnT_SrOq3PsrRm2SqQ%40mail.g...
David J.
On Fri, Oct 2, 2020 at 2:00 PM David G. Johnston <david.g.johnston@gmail.com>
wrote:
> On Mon, Sep 14, 2020 at 6:03 PM David G. Johnston <
> david.g.johnston@gmail.com> wrote:
>
>> Given that 7.6 is named "LIMIT and OFFSET" I don't have an issue with
>> adding the relevant keywords (including EXCEPT and INTERSECT) in those two
>> places.
>>
>
> Patch attached.
>
> David J.
>
^ permalink raw reply [nested|flat] 4+ messages in thread
end of thread, other threads:[~2020-10-21 15:02 UTC | newest]
Thread overview: 4+ messages (download: mbox mbox.gz follow: Atom feed)
-- links below jump to the message on this page --
2020-09-11 08:45 Chapter 7. Queries PG Doc comments form <noreply@postgresql.org>
2020-09-15 01:03 ` David G. Johnston <david.g.johnston@gmail.com>
2020-10-02 21:00 ` David G. Johnston <david.g.johnston@gmail.com>
2020-10-21 15:02 ` David G. Johnston <david.g.johnston@gmail.com>
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