Chapter 7. Queries
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.
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.
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.patchapplication/octet-stream; name=v1-doc-add-select-literals-to-queries-section-headers.patchDownload+2-2
Moved to -hackers and commitfest
/messages/by-id/CAKFQuwbqkcLCJ3gXUjso74gy80yNkB=FQnT_SrOq3PsrRm2SqQ@mail.gmail.com
David J.
On Fri, Oct 2, 2020 at 2:00 PM David G. Johnston <david.g.johnston@gmail.com>
wrote:
Show quoted text
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.